Thanks to visit codestin.com
Credit goes to github.com

Skip to content
This repository was archived by the owner on Jun 26, 2025. It is now read-only.

Home

Jump to bottom
Charles-P. Clermont edited this page Oct 1, 2017 · 4 revisions

Habitica CLI Wiki

There's quite a few things you can do with this tool.

Commands

help

Provides help for a given command.

habitica $ help

  Commands:

    help [command...]                    Provides help for a given command.
    exit                                 Exits application.
    status                               List your stats.
    habits list                          List your habits.
    habits score [options] [ids...]      Score one or multiple habits.
    habits add                           Create a new habit.
    habits delete [ids...]               Delete habits.
    dailies list [options]               List your dailies.
    dailies complete [options] [ids...]  Complete one or multiple dailies.
    dailies add                          Create a new habit.
    dailies delete [ids...]              Delete dailies.
    todos list [options]                 List your todos.
    todos add [options]                  Create a new task.
    todos complete [options] [ids...]    Score one or multiple habits.
    todos delete [ids...]                Delete todos.
    shop                                 List available rewards for purchase.
    quest                                List current quest details.
    sync                                 Runs cron.

habitica $ help dailies list

  Usage: dailies list [options]

  Alias: dailies | d

  List your dailies.

  Options:

    --help                 output usage information
    -f, --filter [filter]  List filter type (all | due | grey).

status

Lists your character stats.

Aliases: stats

habitica $ status

Warrior - Level 24
HP: 35.14 / 50
MP: 37.01 / 74
XP: 173.00 / 520
GOLD: 1.91

habits

Below you'll find all habits related actions.

habits list

Lists your habits.

Aliases: habits | h

habitica $ habits
────────────────────────────────────────────────────
 1   🕓 Spend 30 minutes on hacker news or reddit
────────────────────────────────────────────────────
 2   📨 Look at emails more than twice a day
────────────────────────────────────────────────────
 3   🍎 Eat a fruit
────────────────────────────────────────────────────

habits score

Score one or multiple habits.

Usage: habits score [options] [ids...]

Aliases: hs

Options:

  • -d, --down Score a habit down.
habitica $ habits score 12 13
+2.00 MP, +2.90 GP, +20.00 XP
You've found a Flying Pig Egg!
+2.9 damage to boss!

habitica $ habits score -d 1 2
-10.00 HP, -2.00 MP, -2.90 GP, -20.00 XP

habits add

Create a new habit.

Usage: habits add [options]

Aliases: new habit | ha

habitica $ habits add
What should we call it? Floss
Any notes? You have a beautiful smile :)
Positive?  Yes
Negative?  No
How difficult?  TRIVIAL
Success!

habits delete

Delete habits.

Usage: habits delete [options] [ids...]

Aliases: habit delete | destroy habit | destroy habits | hd

habitica $ destroy habit 1
Success!

dailies

dailies list

List your dailies.

Usage: dailies list [options]

Aliases: dailies | d

Options:

  • -f, --filter [filter], List filter type (all | due | grey).
habitica $ dailies
────────────────────────────────────
 0  ❤️  Do something for wifey
────────────────────────────────────
 2  😎 Do some code
────────────────────────────────────

habitica $ d -f all
────────────────────────────────────
 0  ❤️  Do something for wifey
────────────────────────────────────
 1  ⚡️ Contribute to habitica-cli
────────────────────────────────────
 2  😎 Do some code
────────────────────────────────────

dailies complete

Score one or multiple habits.

Usage: dailies complete [options] [ids...]

Alias: dailies score | dc | ds

Options:

  • -d, --down Undo a complete action on a task.
habitica $ dailies complete 1 2
+2.00 MP, +2.90 GP, +20.00 XP
You've found a Flying Pig Egg!
+2.9 damage to boss!

habitica $ dailies complete --down C0
-1.00 MP, -1.03 GP, -6.00 XP

dailies add

Create a new daily.

Usage: dailies add [options]

Aliases: new dailies | new daily | da

Options:

  • -m, --message [message] Use the given [message] as todo title and skip the prompt.

dailies delete

Delete dailies.

Usage: dailies delete [options] [ids...]

Alias: dailies delete | destroy dailies | destroy daily | dd

habitica $ dailies delete 1
Success!

todos

todos list

List your todos.

Usage: todos list [options]

Aliases: todos | t

Options:

  • -f, --filter [filter], List filter type (all | dated | completed).
habitica $ todos
─────────────────────────────────────────────────
 0      🔥 Make a habitica-cli demo gif
─────────────────────────────────────────────────
 1      🚀 Show others how to use habitica-cli
─────────────────────────────────────────────────
 2      💨 Publish habitica-cli on npm
─────────────────────────────────────────────────

habitica $ t -f all
─────────────────────────────────────────────────
 0      🔥 Make a habitica-cli demo gif
─────────────────────────────────────────────────
 1      🚀 Show others how to use habitica-cli
─────────────────────────────────────────────────
 2      💨 Publish habitica-cli on npm
─────────────────────────────────────────────────
 C0  X  Join Habitica (Check me off!)
─────────────────────────────────────────────────

todos complete

Score one or multiple habits.

Usage: todos complete [options] [ids...]

Alias: todos score | tc | ts

Options:

  • -u, --undo Uncomplete a todo.
  • -d, --down Uncomplete a todo. (alias)
habitica $ todos complete 1 2
+2.00 MP, +2.90 GP, +20.00 XP
You've found a Flying Pig Egg!
+2.9 damage to boss!

habitica $ todos complete --undo C0
-1.00 MP, -1.03 GP, -6.00 XP

todos add

Create a new task.

Usage: todos add [options]

Aliases: new todo | ta

Options:

  • -m, --message [message] Use the given [message] as todo title and skip the prompt.

todos delete

Delete todos.

Usage: todos delete [options] [ids...]

Alias: todo delete | destroy todos | destroy todo | td

habitica $ todos delete 1
Success!

rewards

quest

sync

exit

Clone this wiki locally