@yamagh/todo-cli
v1.0.2
Published
Task management CLI for AI agents
Downloads
328
Readme
todo-cli
A minimal CLI tool that enables autonomous task and context management for AI agents.
Overview
Designed to help AI agents maintain awareness of their "work units" (workspaces) and prevent "context pollution" during long development or research sessions. It features JSON-based data management that is easily parseable by AI, alongside an intuitive command structure for human operation.
Installation
npm install -g @yamagh/todo-cli(Alternatively, run npm link within this repository to register it as a global command)
Commands
Initialization
todo init: Initialize a local.todo-clidirectory in the current folder.
Workspace Management (Workspace)
Separates unrelated tasks by switching work units.
todo ws list: Display a list of workspaces.todo ws create <name>: Create a new workspace.todo ws switch <name>: Switch the active workspace.todo ws remove <name>: Remove a workspace and its associated tasks.
Task Management (Task)
todo add "<description>" [-p <level>] [-n <message>]: Add a new task.todo list [-s <status>] [-p <priority>] [-d <description>] [-n <note>]: Display a list of tasks.todo update <id> --status <status>: Update a task's status.todo remove <id>: Remove a task.
Logic & Planning Support (Logic)
todo priority <id> <level>: Set priority (managed as a numeric value, e.g., 100 or 0).todo note <id> "<message>": Update a task's note.todo next: Get the next task to process (highest priority and pending).
Data Storage Location
Data is stored under the local .todo-cli directory if initialized via todo init, otherwise it falls back to the user's home directory.
./.todo-cli/active_workspaceor~/.todo-cli/active_workspace: The currently selected workspace name./.todo-cli/workspaces/<name>.jsonor~/.todo-cli/workspaces/<name>.json: Task data for each workspace
How to Integrate with AI Agents
The following instructions are recommended for your AI agent's system prompt:
- Execute
todo ws switch <feature-name>at the start of a task. - Ensure completed steps are reflected by running
todo update <id> --status done. - For complex work, utilize
todo noteto externalize context.
