Skip to main content

A command-line tool for interacting with Reclaim.ai for task management.

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
    edit-task (edit)       edit a task
    list-events (events)   list calendar events
    list-tasks (list)      list tasks
    log-work (log)         log work to a task
    mark-task (mark)       mark a task (in)complete
    show-load (load)       show estimated workload
    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, --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.

Authentication

To authenticate the tool with Reclaim.ai, you first need to obtain an API token from your account. Visit the developer settings page and generate a new API token. Once you have your token, you can provide it to the reclaim CLI in one of two ways

(1) Add the token to the configuration file ~/.reclaim in your home directory:

$ echo "reclaim_token: <token>" >> ~/.reclaim

(2) Set the environment variable RECLAIM_TOKEN with your token value:

$ export RECLAIM_TOKEN=<token>

This ensures the tool can securely authenticate and interact with your Reclaim.ai account.

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 10 days. You would run:

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

The output of the tool is shown as comment in the example. Task IDs are prefixed with t and use a scrambled base36 encoding. You can then list your tasks like this:

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

Your 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 t3k9mw --duration 4h
# ✓ Edited | Id: t3k9mw | Title: Write new blog post

You can also view your upcoming calendar events with the list-events command:

reclaim list-events --future 3
# Id      Date        Start    Dur  Type  Title
# t3k9mw  2025-04-10  09:00   1h0m   T3   Write new blog post
# h2plta  2025-04-10  12:30   1h0m   H1   🍕 Lunch
# m3hsaa  2025-04-11  14:00   1h0m   M4   Team Meeting

Events are shown with a compact type code: T for tasks, H for habits, M for meetings, each followed by the priority digit. The ID column links events back to their source — task IDs can be passed directly to other commands such as show, edit, or start.

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

reclaim delete-task t3k9mw
# ✓ Deleted | Id: t3k9mw | 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.

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.2.0.tar.gz (19.4 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.2.0-py3-none-any.whl (22.7 kB view details)

Uploaded Python 3

File details

Details for the file reclaim_cli-0.2.0.tar.gz.

File metadata

  • Download URL: reclaim_cli-0.2.0.tar.gz
  • Upload date:
  • Size: 19.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for reclaim_cli-0.2.0.tar.gz
Algorithm Hash digest
SHA256 c86c1744776544ae697e0488f16793e7b9015b9c9df911bf957e254bf41d50c3
MD5 2ebd5a460a20814efe89508ae5701dd6
BLAKE2b-256 6624625fb31d57998fded4a611fe654fdc781555a3b241cec4ff89835e01910e

See more details on using hashes here.

File details

Details for the file reclaim_cli-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: reclaim_cli-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 22.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.11

File hashes

Hashes for reclaim_cli-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cc2b3bfa57a0e00b5aad086beaffbc988b87834367c2780e0dfac948b63d34ab
MD5 398c4a5db50d79ee7f961afd45a9750c
BLAKE2b-256 49f08117a114c1d66b3bdc980c4ed5b521431495a8c070687448ab17268cf1a6

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