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
    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.

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 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.

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.4.tar.gz (17.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.4-py3-none-any.whl (20.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for reclaim_cli-0.1.4.tar.gz
Algorithm Hash digest
SHA256 3f7aedadcb610e29a39009352379a9c65a57a64131aa6d1831d54e42fccc543f
MD5 2d66d273865d4d4c913db6a8ba02561f
BLAKE2b-256 106fc655ddfcf6bf1f87d98f23cb57c0aea2f8c8ac5ff2fa794997221d9a8a6b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for reclaim_cli-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7728614cb63bdb95b15a9f4f0336da9ca8d652eff41e03192b87cc149f12f279
MD5 946e57bfc67d9bb3c87daddbd8dcda92
BLAKE2b-256 f55e67f976b08e4fd1dd9a07cbe70593cd83230872fd3fb9e8b73b6c0bedf84f

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