# TodoBud

> TodoBud manages todos, projects, notes, and activities. Start with the CLI guide when working on behalf of a user.

## Guides

- [CLI & agent guide](https://todobud.com/cli/): Installation, authentication, command discovery, JSON output, and task progress updates.
- [API guide](https://todobud.com/api/guide.md): Machine-readable instructions for direct API integrations.
- [API documentation](https://todobud.com/api/docs/): Interactive endpoint reference (staff only).
- [OpenAPI schema](https://todobud.com/api/schema/): API schema (staff only).

## Quick start

Check `todobud auth status`. If the CLI is missing or authentication fails, ask the user to run `npm install -g todobud` and `todobud auth login`. For headless environments, use `todobud auth login --device` with user authorization.

Use `todobud --help` and command-specific `--help` to discover commands. Use `todobud --json ...` when parsing output.

Read the assigned todo before acting. Keep its status and comments current, link the actual PR when one exists, and only mark work done after completing its requirements. Follow the user's repository instructions.

Never put API keys or access tokens in URLs, logs, activity messages, or notes.