{"id":14008519,"url":"https://github.com/charlespwd/habitica-cli","last_synced_at":"2025-03-17T01:29:25.355Z","repository":{"id":48000151,"uuid":"104822390","full_name":"charlespwd/habitica-cli","owner":"charlespwd","description":"An immersive command line interface for Habitica :zap::fire:","archived":false,"fork":false,"pushed_at":"2023-01-24T23:22:51.000Z","size":398,"stargazers_count":36,"open_issues_count":15,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-12T18:04:39.513Z","etag":null,"topics":["cli","habitica","habitica-cli","todo","todoapp"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/charlespwd.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-09-26T01:52:55.000Z","updated_at":"2024-11-11T06:02:49.000Z","dependencies_parsed_at":"2023-02-14T02:31:08.890Z","dependency_job_id":null,"html_url":"https://github.com/charlespwd/habitica-cli","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charlespwd%2Fhabitica-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charlespwd%2Fhabitica-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charlespwd%2Fhabitica-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charlespwd%2Fhabitica-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/charlespwd","download_url":"https://codeload.github.com/charlespwd/habitica-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243957628,"owners_count":20374712,"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","habitica","habitica-cli","todo","todoapp"],"created_at":"2024-08-10T11:01:46.011Z","updated_at":"2025-03-17T01:29:25.331Z","avatar_url":"https://github.com/charlespwd.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003e **Warning**\n\u003e _This project is no longer maintained._\n\n# habitica-cli\n\nAn immersive command line interface for [Habitica](https://habitica.com) which features built-in emoji support, command history and tab completion!\n\n## Demo\n\n\u003cimg alt=\"Demo\" src=\"./img/demo.gif\" width=\"75%\" /\u003e\n\n## Introduction\n\nBuilt on top of [vorpal](https://github.com/dthree/vorpal), this Habitica CLI is an interactive one that provides an array of functionality including the following:\n\n* [x] Built-in emoji support :fire::zap:\n* [x] Listing, scoring, creating, deleting habits, tasks and todos\n* [x] Scoring habits, tasks and todos\n* [x] Creating/Deleting habits, tasks and todos\n* [x] Accessing the rewards shop and buying gear/rewards\n* [x] Casting spells\n* [x] Fighting bosses\n* [x] Showing quest progress\n* [x] Command history\n* [x] Tab completion\n* [x] Short aliases for power users :fire::fire:\n\nThis project was summoned with :heart: by @charlespwd.\n\n## Getting started\n\n### Quick start\n\nInstall `habitica-cli` on your computer:\n\n```\nnpm install -g habitica-cli\n```\n\nCreate a file `~/.config/habitica/auth.cfg` (you may need to create the folder(s) and file) with the following contents:\n\n```\n[Habitica]\nlogin = USER_ID\npassword = API_KEY\n```\n\nReplace `USER_ID` and `API_KEY` with the corresponding tokens from [your Habitica settings\u003eAPI page](https://habitica.com/#/options/settings/api).\n\nOnce that's done, all you have to do is start `habitica` from the command line:\n\n```\n$ habitica\n```\n\nGreat! You're in the CLI! You can now list your tasks:\n\n```\nhabitica $ habits\nhabitica $ dailies\nhabitica $ todos\n```\n\nYou can also check them off:\n\n```\nhabitica $ habits score 1 2 3\nhabitica $ habits score --down 1 2 3\nhabitica $ dailies complete 1 2 3\nhabitica $ todos complete 1 2 3\n```\n\nOr create new ones!\n\n```\nhabitica $ new habit\nhabitica $ new todo\nhabitica $ new daily\n```\n\nIn fact, most of the information you need on how to use any of those commands is available through the very VERY helpful `help` command.  (We're not talking Windows Help here. We're talking about a no fluff list of everything you can do and their multiple aliases).\n\n```\nhabitica $ help\n\n  Commands:\n\n    help [command...]                    Provides help for a given command.\n    exit                                 Exits application.\n    status                               List your stats.\n    habits list                          List your habits.\n    /* ... truncated for brevity ... */\n\nhabitica $ help todos list\n\n  Usage: todos list [options]\n\n  Alias: todos | t\n\n  List your todos.\n\n  Options:\n\n    --help                 output usage information\n    -f, --filter [filter]  List filter type (all | dated | completed).\n\n```\n\n## User Guide\n\nFor more in-depth examples of every single commands, [you can check out the Wiki](https://github.com/charlespwd/habitica-cli/wiki)! Although it's a work in progress.\n\n## Contributing\n\nHelp and PR's are extremely welcome :)\n\n## License\n\nMIT.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharlespwd%2Fhabitica-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcharlespwd%2Fhabitica-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharlespwd%2Fhabitica-cli/lists"}