typebasedio/ctask
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

docs: refresh README for v0.6.0 (version, full command list, features)

Browse Source
This commit is contained in:
typebasedio
2026-05-15 16:01:12 -04:00
parent 7946667fe3
commit fc455841e2
1 changed files with 15 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+15 -8
View File
@@ -6,16 +6,18 @@ ctask gives developers dedicated directories with consistent structure, visible
## Status
v0.2.0 -- local use, not published to any package registry. Windows-primary, cross-platform design.
v0.6.0 -- local use, not published to any package registry. Windows-primary, cross-platform design.
## Key Features
- **Named workspaces** with consistent layout (task metadata, notes, context, output, logs)
- **Named workspaces** with consistent layout (task metadata, agent instructions, notes, context, output, logs)
- **Session traceability** -- automatic file-change snapshot logging on every session
- **Agent-agnostic** -- default agent is Claude Code, but any CLI agent or shell works
- **Agent-agnostic** -- built-in profiles for Claude Code and OpenCode, plus a `custom` escape hatch for any CLI agent or shell
- **Global config** -- optional user-level config file for defaults (agent, roots, session mode), with source attribution in `doctor`
- **Session recovery** -- PID-aware lease detection: a workspace whose owner process has died is recovered immediately, with no stale-wait
- **Query resolution** -- find workspaces by name, slug, or substring
- **Status line** -- persistent session context inside Claude Code's UI
- **Doctor** -- verify setup and diagnose configuration problems
- **Doctor** -- verify setup, diagnose configuration problems, and validate agent setup
- **Safe delete** -- active workspace protection prevents accidental data loss
## Install (Windows)
@@ -55,11 +57,16 @@ ctask resume auth-bug
| `ctask new [title]` | Create a new workspace and launch the agent |
| `ctask list` | Show recent workspaces |
| `ctask resume <query>` | Reopen a workspace and launch the agent |
| `ctask open <query>` | Open a workspace in a shell (no agent) |
| `ctask info <query>` | Display workspace metadata |
| `ctask archive <query>` | Mark a workspace as archived |
| `ctask last` | Resume the most recently updated workspace |
| `ctask doctor` | Verify ctask setup |
| `ctask open <query>` | Open a workspace directory without launching the agent |
| `ctask attach <workspace>` | Attach to a workspace via tmux (persistent session) |
| `ctask info <query>` | Display workspace metadata and path |
| `ctask path <query>` | Print the absolute filesystem path of a workspace |
| `ctask notes <query>` | Print a workspace's notes.md to stdout |
| `ctask archive <query>` | Mark a workspace as archived |
| `ctask restore <query>` | Un-archive a workspace (set status back to active) |
| `ctask agents check [workspace]` | Validate the agent configuration for a workspace |
| `ctask doctor` | Verify ctask setup and diagnose configuration problems |
| `ctask delete <query>` | Permanently remove a workspace |
See [docs/commands.md](docs/commands.md) for full usage.