Skip to main content

CLI for Reclaim.ai service

Project description

Reclaim CLI

This tool provides a simple and flexible command-line interface (CLI) for managing tasks at Reclaim.ai. At its core, the tool operates through a set of commands, each targeting a specific aspect of task management. The commands allow you to create tasks, log work, lists tasks, start and stop time tracking, and more.

To see the available commands, you can simply run reclaim --help, once the tools has been installed.

reclaim --help
usage: reclaim [options] <command> ...

Reclaim CLI

positional arguments:
    add-time (add)                      add time to a task
    create-task (create)                create a task
    delete-task (delete)                delete a task
    list-tasks (list)                   list tasks
    log-work (log)                      log work to a task
    mark-task (mark)                    mark a task (in)complete
    show-task (show)                    show a task
    start-task (start)                  start a task
    stop-task (stop)                    stop a task

options:
  -h, --help                            show this help message and exit
  -c <file>, --config <file>            set config file (default: ~/.reclaim)

Each command can be extended with its further options. Simply run reclaim <command> --help to the see available options for a command. For example, the following output shows all options available with the command create-task:

$ reclaim create-task --help
usage: reclaim create-task [...] <title>

positional arguments:
  <title>                               title of the task

options:
  -h, --help                            show this help message and exit
  -d <datetime>, --due <datetime>       due date of the task
  -p <priority>, --priority <priority>  priority of the task
  -D <duration>, --duration <duration>  duration of the task
  -m <duration>, --min-chunk-size <duration>
                                        minimum chunk size
  -M <duration>, --max-chunk-size <duration>
                                        maximum chunk size
  -s <datetime>, --snooze-until <datetime>
                                        snooze until

Example

Here is a simple example illustrating how to use the tool. Suppose you want to create a task for writing a new blog post with a duration of 8 hours and a due date in 20 days. You would run:

reclaim create-task "Write new blog post" --duration 8h -due "in 10 days" 
# ✓ Created | Id: 5g5p4 | Title: Write new blog post

The output of the tool is shown as comment in the example. You can then list your tasks like this:

reclaim list-tasks
# Id     Due          Left  Prog  State  Title                  
# 5g5p4  2025-04-13   8h0m    0%   N3    Write new blog post

You task has state N (new) with default priority 3. Later, you realize that you need less time for the task. Simply update it using its identifier:

reclaim edit-task 5g5p4 --duration 4h
# ✓ Edited | Id: 5g5p4 | Title: Write new blog post

Eventually, you notice that nobody reads blogs anymore, so you delete the task and move on:

reclaim delete-task 5g5p4
# ✓ Deleted | Id: 5g5p4 | Title: Write new blog post

Installation

The tool is easiest installed directly via pip

pip install reclaim-cli

This will install the latest version of the tool. You can also install it in development mode by cloning the Github repository and running:

git clone https://github.com/rieck/reclaim-cli.git
cd reclaim-cli
pip install -e ".[dev]"

After installation, the reclaim command will be available in your local environment. If you want to work on the tool, you can use the following tools to streamline your implementation.

pre-commit install
black src/
isort src/
flake8 src/
pytest

Dependencies

The tool relies on the unofficial Reclaim.ai Python SDK developed by Labiso GmbH. However, since it requires functionality beyond what is available in version v0.6.3 of the SDK, the dependency is installed from a patched fork.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

reclaim_cli-0.1.1.post2.tar.gz (15.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

reclaim_cli-0.1.1.post2-py3-none-any.whl (17.5 kB view details)

Uploaded Python 3

File details

Details for the file reclaim_cli-0.1.1.post2.tar.gz.

File metadata

  • Download URL: reclaim_cli-0.1.1.post2.tar.gz
  • Upload date:
  • Size: 15.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.10

File hashes

Hashes for reclaim_cli-0.1.1.post2.tar.gz
Algorithm Hash digest
SHA256 aa31c88c336edd2fdeddb1fb9fa2ad47b7aae039a910df16e9ba0134039c5212
MD5 3c054fb94719fd563de3be921b488511
BLAKE2b-256 8d3ae6d64db70c6357a1ddeb470b70b392b9c86d70d9ce6e7f9f426d321665ef

See more details on using hashes here.

File details

Details for the file reclaim_cli-0.1.1.post2-py3-none-any.whl.

File metadata

File hashes

Hashes for reclaim_cli-0.1.1.post2-py3-none-any.whl
Algorithm Hash digest
SHA256 f19b0f69406828bd3f50d783b9ba9fae88244e61136a403827b9a1cd86f8602a
MD5 bc827652d6fd72b983e93fb44a080d2f
BLAKE2b-256 d08cd55ecc7c0831e4dacd272fc0ed54406b7458898a4a6943ce11bf4f1fc265

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page