https://github.com/obreitwi/neorg-task-sync
Sync TODOs from Neorg Journal with Google Tasks
https://github.com/obreitwi/neorg-task-sync
google-tasks neorg
Last synced: 7 months ago
JSON representation
Sync TODOs from Neorg Journal with Google Tasks
- Host: GitHub
- URL: https://github.com/obreitwi/neorg-task-sync
- Owner: obreitwi
- License: other
- Created: 2023-05-08T21:01:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-20T15:55:37.000Z (about 1 year ago)
- Last Synced: 2024-08-02T20:55:03.336Z (about 1 year ago)
- Topics: google-tasks, neorg
- Language: Rust
- Homepage:
- Size: 115 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# Sync: Neorg ⇄ GTask
Sync your Neorg TODO-items to Google tasks and vice-versa.
## What?
`neorg-task-sync` syncs all uncompleted todo-entries from your neorg journal to a google task list and vice versa.
It allows you to double-check/complete todos on your mobile phone while commuting.
Alternatively, this workflow allows for noting down todos while away from your computer and still have them appear in the newest neorg journal file.
By default, new tasks are synced to the latest journal entry .
Tasks are synced to the last (optionally first) file you specify on the command line, optionally to a specific section (by default `TODO`).
This ensures that the latest journal file receives new remote tasks.
While syncing the your journal is the intended use-case it also allows syncing to any other file.
If configured,
## Why?
I keep notes via [Neorg's journal feature](https://github.com/nvim-neorg/neorg/wiki/Journal).
However, I would also like to add TODOs when I am away from the PC (for example after spontaneous meetings).
Furthermore, I like to go through and update older TODOs while commuting.
For obvious reasons, Neorg's journaling feature cannot solve this, but Google Tasks does.
Hence, the _obvious_ solution was to write a quick syncer.
The required metadata is concealed via treesitter-rules.
## How? (Installation)
Unfortunately, Google does not permit shipping client IDs with open source code.
Hence, the installation procedure is:
1. Install locally
2. Create your own Google project & OAuth token
### Install locally
1. Install as `neovim` plugin:
```vim
Plug 'obreitwi/neorg-task-sync' " vim-plug
```
2. Navigate to the plugin folder (or clone again to install):
```bash
git clone https://github.com/obreitwi/neorg-task-sync.git
cd neorg-task-sync
cargo install --path "$PWD"
# pre-create config folder
mkdir -p ~/.config/neorg-task-sync
```
### Create your own Google project & OAuth token
0. (Register for [Google Cloud](https://console.cloud.google.com), if not done already…)
1. [Create a new Google Project](https://console.cloud.google.com/projectcreate).
The name does not matter much since you will only use it for yourself.
Alternatively, you can also re-use an existing private project of yours.
2. For your project, enable [Google Tasks API](https://console.cloud.google.com/marketplace/product/google/tasks.googleapis.com)
3. Create a [new OAuth 2.0 client](https://console.cloud.google.com/apis/credentials/oauthclient).
For _Application Type_, choose "Desktop App" and any name.
4. After creation, make sure to download the OAuth client to
```
~/.config/neorg-task-sync/clientsecret.json
```
### Required configuration
The only required confguration is to set a remote task list.
It can be set interactively via `neorg-task-sync config tasklist set`.
### Run your first sync
Run your first sync via
```
$ neorg-task-sync
```
Tip: Set `alias nts=neorg-task-sync` for your shell.
## Full Configuration
`neorg-task-sync` can be configured in several ways:
* `${XDG_CONFIG_HOME}/neorg-task-sync/config.yaml` (defaults to: `$HOME/.config/neorg-task-sync-config.yaml`)
* by specifing an env variable for each config setting, prefixed with `NEORG_TASK_SYNC_` (e.g. `NEORG_TASK_SYNC_TASKLIST` to specify a tasklist)
* the only required setting (which tasklist to sync to) can be set interactively via `neorg-task-sync config tasklist set`
### Config values (with defaults)
```yaml
# clear google tasks older than n days, disabled if not specified
clear_completed_tasks_older_than_days:
# ignore the following files when syncing
ignore_filenames: ["index.norg"]
# which google task list to sync to, set via `neorg-task-list config tasklist set`
tasklist: ""
# which section to sync todos to, alternatively they are appended to the file
section_todos: "TODOs"
# section containing todos tha should be done till end-of-day
# these todos will be synced with a same-day due date
section_todos_till_end_of_day: ""
```
# Command-Line Help for `neorg-task-sync`
This document contains the help content for the `neorg-task-sync` command-line program.
**Command Overview:**
* [`neorg-task-sync`↴](#neorg-task-sync)
* [`neorg-task-sync auth`↴](#neorg-task-sync-auth)
* [`neorg-task-sync auth login`↴](#neorg-task-sync-auth-login)
* [`neorg-task-sync config`↴](#neorg-task-sync-config)
* [`neorg-task-sync config import`↴](#neorg-task-sync-config-import)
* [`neorg-task-sync config show`↴](#neorg-task-sync-config-show)
* [`neorg-task-sync config tasklist`↴](#neorg-task-sync-config-tasklist)
* [`neorg-task-sync generate`↴](#neorg-task-sync-generate)
* [`neorg-task-sync generate help-markdown`↴](#neorg-task-sync-generate-help-markdown)
* [`neorg-task-sync generate completion`↴](#neorg-task-sync-generate-completion)
* [`neorg-task-sync parse`↴](#neorg-task-sync-parse)
* [`neorg-task-sync sync`↴](#neorg-task-sync-sync)
* [`neorg-task-sync tasks`↴](#neorg-task-sync-tasks)
## `neorg-task-sync`
**Usage:** `neorg-task-sync [OPTIONS] `
###### **Subcommands:**
* `auth` — Auth related commands
* `config` — Show config
* `generate` — Generate completions
* `parse` — Run a parse action (mainly for debugging)
* `sync` — Sync tasks between local file and google tasks
* `tasks` — Check which tasks are defined upstream (mainly for debugging)
###### **Options:**
* `-v`, `--verbose` — Make output more verbose
## `neorg-task-sync auth`
Auth related commands
**Usage:** `neorg-task-sync auth `
###### **Subcommands:**
* `login` —
## `neorg-task-sync auth login`
**Usage:** `neorg-task-sync auth login`
## `neorg-task-sync config`
Show config
**Usage:** `neorg-task-sync config `
###### **Subcommands:**
* `import` —
* `show` —
* `tasklist` —
## `neorg-task-sync config import`
**Usage:** `neorg-task-sync config import [OPTIONS] `
###### **Arguments:**
* `` — what to import
Possible values: `client-secret`
###### **Options:**
* `-f`, `--file ` — Read from file
## `neorg-task-sync config show`
**Usage:** `neorg-task-sync config show`
## `neorg-task-sync config tasklist`
**Usage:** `neorg-task-sync config tasklist [VALUE]`
###### **Arguments:**
* ``
Possible values:
- `get`:
Get current value
- `set`:
Set current value
- `list`:
List possible values current value
* `` — Value (for set operation)
## `neorg-task-sync generate`
Generate completions
**Usage:** `neorg-task-sync generate `
###### **Subcommands:**
* `help-markdown` — Generate markdown from help messages
* `completion` — Copmletion script
## `neorg-task-sync generate help-markdown`
Generate markdown from help messages
**Usage:** `neorg-task-sync generate help-markdown`
## `neorg-task-sync generate completion`
Copmletion script
**Usage:** `neorg-task-sync generate completion `
###### **Arguments:**
* `` — Shell to generate completions for
Possible values: `bash`, `elvish`, `fish`, `powershell`, `zsh`
## `neorg-task-sync parse`
Run a parse action (mainly for debugging)
**Usage:** `neorg-task-sync parse [OPTIONS] `
###### **Arguments:**
* `` — What to generate
###### **Options:**
* `-f`, `--force-norg` — Force parsing even if extension does not match
## `neorg-task-sync sync`
Sync tasks between local file and google tasks
**Usage:** `neorg-task-sync sync [OPTIONS] ...`
###### **Arguments:**
* `` — Files or folders to sync. New remote tasks will be synced into the last file specified (after sorting)
###### **Options:**
* `--fix-missing`
* `-f`, `--pull-to-first` — Pull new remote tasks to first file specified, instead
* `-s`, `--without-sort` — Do not sort filenames prior to syncing
* `-L`, `--without-local` — Do not sync remote google tasks to local todos (neither create nor update status)
* `-R`, `--without-remote` — Do not sync local todos to remote google tasks (neither create nor update status)
* `-r`, `--without-push` — Do not push local todos to google and create new tasks
* `-l`, `--without-pull` — Do not pull remote google tasks and insert them into the todo section
## `neorg-task-sync tasks`
Check which tasks are defined upstream (mainly for debugging)
**Usage:** `neorg-task-sync tasks [OPTIONS]`
###### **Options:**
* `-j`, `--json` — output as json
This document was generated automatically by
clap-markdown.