diff --git a/README.md b/README.md index f7c0434..f4d3818 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,14 @@ cc-timer "2h10m" "Explore if this is this the real life? " - Keep pending jobs in a JSON state file so they can be listed or canceled later. - Work the same way on macOS, Linux, and Windows without shell-specific tricks. +## Glossary + +`cc-timer` uses three related terms consistently: + +- **Task** — one unit of work you provide (a positional argument, a `--task`, or a line from `--file`). Each task becomes a single `claude --bg ` invocation. +- **Job** — the scheduled record that groups one or more tasks under a single dispatch time. Jobs are what you `list` and `cancel`; each has an id like `ct_9f2aXY`. +- **Agent** — the Claude Code background agent a task turns into once the job is dispatched. After dispatch, agents appear in `claude agents` and are managed there, not by `cc-timer`. + ## Install Install globally from npm: @@ -53,7 +61,7 @@ cc-timer "45m" "Investigate this landslide, why no escape from reality" ``` ```text -[Success] Scheduled 1 task to run in 45 minutes (2700 seconds). +[Success] Scheduled 1 task to run in 45 minutes (2,700 seconds). Dispatch time: 2026-05-18 15:42:00 local time Tasks: - Investigate this landslide, why no escape from reality @@ -174,6 +182,18 @@ cc-timer "2h" \ --dry-run ``` +```text +[Dry-run] Would schedule 2 tasks to run in 2 hours (7,200 seconds). +Dispatch time: 2026-05-18 17:42:00 local time +Commands: +- claude --bg "Ping mama, ooh (any way the wind blows)" +- claude --bg "Respawn I don't wanna die" + +No job was created. +``` + +The dry run prints the exact shell-quoted `claude` invocations under `Commands:`. Add `--json` to get the same preview as a `commands` array. + ## Listing pending jobs ```bash @@ -214,16 +234,16 @@ Cancellation marks the job state before terminating the worker, so a wake-up tha `cc-timer [delay] [tasks...]` — schedule new agents. -| Option | Description | -| ----------------------------- | ---------------------------------------------------------------- | -| `--task ` | Add one task. Repeatable. | -| `--file ` | Read tasks from a text file, one per line. | -| `--at