{"id":21637830,"url":"https://github.com/louis-thevenet/vault-tasks","last_synced_at":"2025-04-11T16:42:21.438Z","repository":{"id":255567064,"uuid":"848234446","full_name":"louis-thevenet/vault-tasks","owner":"louis-thevenet","description":"TUI Markdown Task Manager","archived":false,"fork":false,"pushed_at":"2025-03-30T13:53:34.000Z","size":106911,"stargazers_count":29,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-02T23:23:10.315Z","etag":null,"topics":["markdown","markdown-tasks","ratatui","tasks","tui"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/louis-thevenet.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-08-27T11:42:29.000Z","updated_at":"2025-03-31T00:10:43.000Z","dependencies_parsed_at":"2024-09-17T09:55:12.606Z","dependency_job_id":"2b43e421-70c8-4b2f-99d9-680cf516d3a5","html_url":"https://github.com/louis-thevenet/vault-tasks","commit_stats":null,"previous_names":["louis-thevenet/vault-tasks"],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/louis-thevenet%2Fvault-tasks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/louis-thevenet%2Fvault-tasks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/louis-thevenet%2Fvault-tasks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/louis-thevenet%2Fvault-tasks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/louis-thevenet","download_url":"https://codeload.github.com/louis-thevenet/vault-tasks/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247914539,"owners_count":21017339,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown","markdown-tasks","ratatui","tasks","tui"],"created_at":"2024-11-25T04:07:07.596Z","updated_at":"2025-04-11T16:42:21.427Z","avatar_url":"https://github.com/louis-thevenet.png","language":"Rust","funding_links":[],"categories":["💻 Apps"],"sub_categories":["📝 Productivity and Planning"],"readme":"# Vault-tasks\n\n`vault-tasks` is a TUI Markdown task manager.\n\nIt will parse any Markdown file or vault and display the tasks it contains.\n\n## Demo using `./test-vault`\n\n```\ntest-vault\n├── chocolate_lava_cake.md\n├── daily_workout.md\n├── diy_bookshelf.md\n├── study_plan.md\n└── test.md\n```\n\n![Demo](./examples/demo_full.gif)\n\n## Why\n\nI made this tool because I wanted to integrate my task system directly inside my Second Brain.\n\nMarkdown tasks are very easy to integrate with knowledge/projects and are source-control-friendly.\n\nI also spend most of my writing time in the terminal (Helix) and do not rely on heavy external software.\n\n## Features\n\n- Task Parser (see [Usage](https://github.com/louis-thevenet/vault-tasks/tree/main?tab=readme-ov-file#usage))\n  - Subtasks\n  - Fixed and relative dates\n  - special _today_ tag and regular tags\n  - descriptions, priority, completion percentage\n- Navigate vault\n- Edit tasks or open in default editor\n- Search through tasks (sort and filter)\n- Calendar view and timeline\n- Time Management tab (Pomodoro \u0026 Flowtime)\n\n## Planned Features\n\n- `new` action in Explorer Tab to create a new child on selected entry\n\n## Installation\n\n### Cargo\n\n```\ncargo install vault-tasks\n```\n\n### Nix\n\nYou can get it from nixpkgs 24.11 or directly from this repo's flake:\n\n```nix\nvault-tasks = {\n  url = \"github:louis-thevenet/vault-tasks\";\n  inputs.nixpkgs.follows = \"nixpkgs\";\n};\n```\n\nAnd use the package in your configuration: `inputs.vault-tasks.packages.${pkgs.system}.default`\n\n### Build From Source\n\n```\ngit clone https://github.com/louis-thevenet/vault-tasks.git\ncd vault-tasks\ncargo build --release\n```\n\n## Usage\n\nSee `vault-tasks --help` for basic usage.\n\n### Writing tasks\n\n```md\n\u003c!-- An example task in your markdown file --\u003e\n\n- [ ] An example task #tag tomorrow p1\n      A description\n      of this task\n  - [x] A subtask today @today\n  - [/] Another subtask 10/23 @today c50\n    Partly done\n  - [-] This one is canceled\n```\n\n| Token                                      | Meaning                                                           |\n| ------------------------------------------ | ----------------------------------------------------------------- |\n| `- [ ]` (`- [x]`, ...)                     | declares a task and sets its state                                |\n| `p1` (`p10`, ...)                          | sets the priority                                                 |\n| `c50` (`c99`, `c150`, ...)                 | Sets the completion percentage                                    |\n| `#tag`                                     | is a tag, a task can have zero or more tags                       |\n| `@today` (`@tod`, `@t`)                    | is a special tag that will mark the task as part of today's tasks |\n| `23/10` (`2024/23/10`)                     | sets the due date with a literal date                             |\n| `today` (`tdy`)                            | sets the due date to today                                        |\n| `tomorrow` (`tmr`)                         | sets the due date to tomorrow                                     |\n| a day of the week (`monday` or `mon`, etc) | sets the due date to the next occurence of that day               |\n| `3d` (`3m, 3w, 3y`, ...)                   | means \"in 3 days\" and will set the due date accordingly           |\n\n- Task states are **Done** (`x`), **To-Do** (` `), **Incomplete** (`/`) and **Canceled** (`-`)\n\n- `@today` allows you mark a task for today while keeping a due date. It will show up with a ☀️ in `vault-tasks`.\n\n- Relative dates are always replaced by literal dates once `vault-tasks` is run. Thanks to this, `vault-tasks` does not store any data except its config file.\n\n- Other tokens will be part of the title of that task\n\n- Descriptions and subtasks are declared using indents (see configuration)\n\nThis is what you will see in the preview of this `README.md` in `vault-tasks`:\n\n![](./examples/demo_readme_explorer.png)\n\n\u003c!-- Or when filtering for `@today` tasks: --\u003e\n\u003c!-- ![](./examples/demo_filter.png) --\u003e\n\n### Default Key Map\n\nCheck the key map within the app with `?`\n\n#### General\n\n| Key         | Alternate Key | Action                                    |\n| ----------- | ------------- | ----------------------------------------- |\n| `shift-h`   | `shift-←`     | Previous tab                              |\n| `shift-l`   | `shift-→`     | Next tab                                  |\n| `ctrl-k`    | `ctrl-↓`      | Scroll up                                 |\n| `ctrl-j`    | `ctrl-↑`      | Scroll down                               |\n| `page_down` |               | Scroll one page down                      |\n| `page_up`   |               | Scroll one page up                        |\n| `q`         | `ctrl-c`      | Quit the application                      |\n| `?`         |               | Open keybindings menu for the current tab |\n\n#### Explorer Tab\n\n##### Navigation\n\n| Key | Alternate Key     | Action              |\n| --- | ----------------- | ------------------- |\n| `k` | `↑`, `shift-tab`  | Previous entry      |\n| `j` | `↓`, `tab`        | Next entry          |\n| `h` | `←`, `back_space` | Leave current entry |\n| `l` | `→`,`enter`       | Enter current entry |\n\n##### Commands\n\n| Key | Action                                         |\n| --- | ---------------------------------------------- |\n| `s` | Focus search bar (`enter` or `esc` to unfocus) |\n| `o` | Open selection in default editor               |\n| `e` | Quickly edit selection                         |\n| `r` | Reload vault                                   |\n| `t` | Mark task **To-Do**                            |\n| `d` | Mark task **Done**                             |\n| `i` | Mark task **Incomplete**                       |\n| `c` | Mark task **Canceled**                         |\n\n![](./examples/demo_explorer.gif)\n\n#### Filter Tab\n\n##### Commands\n\n| Key       | Action                   |\n| --------- | ------------------------ |\n| `enter`   | Focus/Unfocus search bar |\n| `Shift-s` | Change sorting mode      |\n\n![](./examples/demo_filter.gif)\n\n#### Calendar Tab\n\n##### Navigation\n\n| Key       | Alternate Key | Action   |\n| --------- | ------------- | -------- |\n| `h`       | `←`           | +1 day   |\n| `l`       | `→`           | -1 day   |\n| `j`       | `↓`           | +7 days  |\n| `k`       | `↑`           | -7 days  |\n| `Shift-j` | `Shift-↓`     | +1 month |\n| `Shift-k` | `Shift-↑`     | -1 month |\n| `n`       |               | +1 year  |\n| `Shift-n` |               | -1 year  |\n\n##### Commands\n\n| Key | Action     |\n| --- | ---------- |\n| `t` | Goto Today |\n\n![](./examples/demo_calendar.gif)\n\n#### Time Management Tab\n\n##### Navigation\n\n| Key | Alternate Key | Action           |\n| --- | ------------- | ---------------- |\n| `k` | `↑`           | Previous setting |\n| `j` | `↓`           | Next setting     |\n\n##### Commands\n\n| Key         | Action                             |\n| ----------- | ---------------------------------- |\n| `space`     | Next segment (skip current)        |\n| `p`         | Pause timer                        |\n| `e`         | Edit selected setting              |\n| `shift-tab` | Previous time management technique |\n| `tab`       | Next time management technique     |\n\n![](./examples/demo_time.gif)\n\n### Modes\n\nYou can start already focused on a tab by using one of the CLI subcommands:\n\n```bash\nvault-tasks explorer # is the default\n# Or\nvault-tasks filter\nvault-tasks time\nvault-tasks calendar\n```\n\nYou can also output the content of a vault in standard output using\n\n```bash\nvault-tasks stdout\n```\n\nExample output:\n\n```\nvault-tasks -v ./README.md stdout\n./README.md\n‾‾‾‾‾‾‾‾‾‾‾\n\tREADME.md\n\t‾‾‾‾‾‾‾‾‾\n\t\tVault-tasks\n\t\t‾‾‾‾‾‾‾‾‾‾‾\n\t\t\tUsage\n\t\t\t‾‾‾‾‾\n\t\t\t\tWriting tasks\n\t\t\t\t‾‾‾‾‾‾‾‾‾‾‾‾‾\n\t\t\t\t\t❌ An example task\n\t\t\t\t\t📅 2025-03-31 (tomorrow) ❗1\n\t\t\t\t\t#tag\n\t\t\t\t\tA description\n\t\t\t\t\tof this task\n\n\t\t\t\t\t\t✅ A subtask\n\t\t\t\t\t\t☀️ 📅 2025-03-30 (today)\n\n\n\t\t\t\t\t\t⏳ Another subtask\n\t\t\t\t\t\t☀️ 📅 2025-10-23 (in 7 months) [🟩🟩⬜️⬜️⬜️ 50%]\n\t\t\t\t\t\tPartly done\n\n\n\t\t\t\t\t\t🚫 This one is canceled\n```\n\n## Configuration\n\nThe [`config.toml`](./.config/config.toml) contains the default configuration which can be generated using `vault-tasks generate-config`.\n\nIn `$HOME/.config/vault-tasks/config.toml`, you can override the default settings, keybindings and colorscheme.\n\nIn particular, you can set a default vault path.\n\n## Contributing\n\nFeel free to submit issues or pull requests. Contributions are welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flouis-thevenet%2Fvault-tasks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flouis-thevenet%2Fvault-tasks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flouis-thevenet%2Fvault-tasks/lists"}