{"id":20799883,"url":"https://github.com/xnacly/opus-cli","last_synced_at":"2025-05-11T16:31:33.547Z","repository":{"id":61605382,"uuid":"532324302","full_name":"xNaCly/opus-cli","owner":"xNaCly","description":"simple to-do manager for power users","archived":false,"fork":false,"pushed_at":"2022-10-25T08:22:10.000Z","size":1809,"stargazers_count":2,"open_issues_count":2,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2023-03-04T02:07:53.066Z","etag":null,"topics":["cli","poweruser","rust","todo"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xNaCly.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-09-03T17:09:28.000Z","updated_at":"2022-11-24T15:55:18.000Z","dependencies_parsed_at":"2023-01-20T10:50:11.472Z","dependency_job_id":null,"html_url":"https://github.com/xNaCly/opus-cli","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xNaCly%2Fopus-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xNaCly%2Fopus-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xNaCly%2Fopus-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xNaCly%2Fopus-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xNaCly","download_url":"https://codeload.github.com/xNaCly/opus-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225073065,"owners_count":17416536,"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":["cli","poweruser","rust","todo"],"created_at":"2024-11-17T18:10:39.308Z","updated_at":"2024-11-17T18:10:39.837Z","avatar_url":"https://github.com/xNaCly.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# opusCli\n\n_simple to-do manager for power users_\n\n-   [Roadmap](https://github.com/xNaCly/opusCli/milestone/2)\n\n## Installation\n\n### Binary\n\n`opus` can be installed via the provided binary files in the release section,\n[here](https://github.com/xNaCly/opusCli/releases).\n\nSelect the latest release, add the `opus` executable to a directory which is registered in the path variable and you're\ngood to go.\n\n### From source\n\n\u003e Make sure [cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html) and\n\u003e [rustup](https://www.rust-lang.org/tools/install) are installed\n\n```bash\ngit clone https://github.com/xnacly/opusCli\ncargo build --release\n./target/release/opus\n```\n\nCargo will now build `opus` for the target you're currently using as a operating system. The resulting executable can be\nfound in the `target` directory: `target/release/opus`\n\n## Usage\n\n### Add a task\n\n-   title is the only required value\n-   opus replaces `@tomorrow` and `@today` with the corresponding dates in `YYYY-mm-DD` notation\n\n```bash\n# add a new task with the following properties:\n# title: review and merge pr 5\n# due: @tomorrow\n# tag: #github\n# priority: 3\nopus add \"review and merge pr 5 @tomorrow #github .3\"\n# add a new task with the given title\nopus a \"review and merge pr 5\"\n```\n\n### List tasks\n\n-   this command hides finished tasks from the `opus ls` command\n\n```bash\n# list all tasks\nopus list\n# list all task + finished tasks\nopus list --finished\n# list all task with the tag #work\nopus list \"#work\"\n# list all tasks with the priority 3\nopus list .3\n# list the task with the id 1\nopus list 1\nopus ls 1\nopus l 1\n# sort list output by task property\nopus list --sort-by=id\nopus list --sort-by=due\nopus list --sort-by=finished\nopus list --sort-by=title\nopus list --sort-by=priority\nopus list --sort-by=tag\n# sort desc and asc (default sort is asc)\nopus list --sort-by=id --sort-order=desc\n# [2]: 'read c how to' (2022-10-17)\n# [1]: 'notion aufsetzen' (2022-10-18) #uni .1\n# --\n# 2 tasks found matching query: 'list'\n```\n\n### Mark a task as finished\n\n-   opus hides finished tasks from the `opus ls` command\n-   contrary to `opus ls`, `opus fin` does only accept a tasks id as the argument\n\n```bash\n# mark the task with id=1 as finished\nopus finish 1\nopus fin 1\nopus f 1\n```\n\n### Remove all tasks\n\n```bash\n# this clears the whole database\nopus clear\n```\n\n### Export Tasks\n\n-   opus exports all tasks to a specified file\n\n```bash\n# exports all tasks in the data.json file\nopus export --format=\"json\" --output=\"data.json\"\n# export all tasks in the data.csv file\nopus export --format=\"csv\" --output=\"data.csv\"\n# export all tasks in the data.tsv file\nopus export --format=\"tsv\" --output=\"data.csv\"\n```\n\n### Delete a task\n\n-   just like `opus finish`, `opus delete` only accepts a tasks id as the argument\n\n```bash\n# delete the task with id=1\nopus delete 1\nopus del 1\nopus d 1\n```\n\n## Configuration\n\n### The `OPUS_PATH` env variable\n\nBy default `opus` decides where to store its database based on your operating system. Currently opus supports\nautomatically figuring out where to store the database on windows, linux and macos.\n\n-   Linux and Macos: `$HOME/opus/opus.db` or `$XDG_CONFIG_HOME/opus/opus.db`\n-   Windows: `%LOCALAPPDATA%/opus/opus.db`\n\nFor use cases which force the use of a different location, opus honors the `OPUS_PATH` environment variable. Set this\nvariable and override the above paths.:\n\n-   Linux: _add to .bashrc (or your shells config file)_\n\n```\nset OPUS_PATH=~/.config # opus will create and use ~/.config/opus/opus.db\n```\n\n-   Windows: Add to your system environment variables\n    _[guide](https://geekflare.com/system-environment-variables-in-windows/)_.\n\n\u003e Opus will create the `opus/opus.db` file and directory in the directory specified in the `OPUS_PATH` variable\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxnacly%2Fopus-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxnacly%2Fopus-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxnacly%2Fopus-cli/lists"}