Skip to main content

CLI for Reclaim.ai service

Project description

Reclaim CLI

Copyright (c) 2025 Konrad Rieck (konrad@mlsec.org)

About

This is a simple Python CLI for the Reclaim service.

Usage

The reclaim tool provides a simple and flexible command-line interface (CLI) for managing tasks at Reclaim.ai. At its core, reclaim 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 run:

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 follows a consistent pattern and can be extended with its own options. Simply run reclaim <command> --help.

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 from Github. You can run

pip install git+https://github.com/rieck/reclaim-cli.git

This will install the latest version of the tool directly from the repository. You can also install it in development mode by cloning the 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 terminal. 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.post1.tar.gz (14.7 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.post1-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: reclaim_cli-0.1.1.post1.tar.gz
  • Upload date:
  • Size: 14.7 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.post1.tar.gz
Algorithm Hash digest
SHA256 ad1b49e94315eeb02c69a8aec2b782055e2812be4fc4d09102d1e3a9c27c7498
MD5 5761720d86a8574347a9013562e3a749
BLAKE2b-256 2e9d72357a869b1d4900afde3da8d325f15e221959e8bddc7db77ee8c86688fe

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for reclaim_cli-0.1.1.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 a0b96fd6fba97b5217b176aa5bbf4b84748395019b572cbb132994854d31fc7e
MD5 1d37168a043da966c6248127ffbf5874
BLAKE2b-256 435082f0bfa71104aa092dc0c24f00eef9c109690ee2c6275d17e6b60b9fceff

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