Commit Graph

9 Commits

Author SHA1 Message Date
typebasedio 4fd0befee1 docs(v0.5.4): rewrite commands.md as a structured reference
Bring docs/commands.md up to current state. The document was last
substantively updated in v0.5; v0.5.2 (restore/notes/path/list --names/
completion + archived-inclusive lookup), v0.5.3 (attach + --direct +
persistent session mode + doctor tmux check), and v0.5.4 (info Session
block + list SESSION column) were all undocumented.

Format follows the spec section §3: each command has Purpose, Usage,
Scenarios, Examples, Flags, Notes, Related. Sections are kept short
(roughly one screen each) — if a command needed more, the command is
doing too much, not the docs.

New non-command sections: workspace layout (task and project), a
consolidated environment-variables table (previously scattered),
explicit query-resolution rules including archive-inclusive lookup
behavior, session modes (direct vs persistent), and a shell-completion
how-to.

Examples use the canonical "ctask" command name per spec §3 — docs
describe the product, not the user's local binary path.
2026-05-14 19:59:22 -04:00
typebasedio 45ea5beba6 docs(v0.5.3): persistent session mode reference 2026-05-08 14:06:02 -04:00
typebasedio 82c944502d docs(v0.5): document project subdirectory, launch_dir, CTASK_LAUNCH_DIR, default discovery
Adds the workspace-layout diagram to the --project section, describes
how launch_dir is set and overridden, and documents the v0.5 rules for
fallback (missing/not-a-dir) and error (absolute/escape). Adds
CTASK_LAUNCH_DIR to the env-vars table and CTASK_PROJECT_ROOT INFO line
to the doctor example. Query Resolution note explains that both
CTASK_ROOT and the default projects/ subdirectory are searched so
default-location projects are findable from any shell.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-22 19:53:32 -04:00
typebasedio 57c6c909d3 feat(v0.4.1): add seed directory checks to ctask doctor
Replaces the always-informational seed-dir block with three-state checks:
INFO when the env var is unset (defaults will be used), PASS when set and
the path exists, FAIL when set but the directory is missing. Only the
configured-but-missing state counts as a failed check and raises the
doctor exit code.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-22 17:56:27 -04:00
typebasedio b4f35231d4 docs(v0.4.1): add nested git guidance for project mode
Project CLAUDE.md template now includes a Git section stating that the
workspace uses a single git repo at the root and subdirectory git init
is not permitted. docs/commands.md picks up the same guidance under the
--project flag section.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-22 17:55:29 -04:00
typebasedio 46c7ef2c5c docs(v0.4): document --force, session lease, stale-workspace detection, and coexisting-session limitation 2026-04-21 17:16:54 -04:00
typebasedio 6532cba94f docs(v0.3): document new ctask list semantics and --task flag
Reflects the v0.3 polish-pass changes:
  - default 'ctask list' shows active tasks AND projects
  - --task flag added; --task and --projects are exclusive
  - output now includes a "type" column
  - 'ctask last' explicitly notes it considers both types
2026-04-10 17:02:58 -04:00
typebasedio dacd8018cf docs(v0.3): document --project, --projects, seed dirs, CTASK_TYPE
Updates docs/commands.md to cover the v0.3 surface:
  - ctask new --project flag, project mode, project root
    semantics, seed order, git init behavior
  - ctask list --projects flag and --all/--projects matrix
  - Seed directory locations (general + project) and skip rules
  - CTASK_TYPE child env var, CTASK_PROJECT_ROOT,
    CTASK_SEED_DIR, CTASK_SEED_PROJECT_DIR config vars
  - Doctor [INFO] seed directory reporting

No remote install or publish commands are added; the project
remains local-only.
2026-04-10 14:57:00 -04:00
typebasedio 401092f55a docs: add README, install, commands, and troubleshooting documentation
README.md: project overview, quick start, command table, install/uninstall summary.
docs/install.md: prerequisites, install/uninstall procedures, install location, PATH behavior, status-line setup.
docs/commands.md: all 9 commands with syntax, flags, examples, query resolution, env vars, exit codes.
docs/troubleshooting.md: practical fixes for PATH, status line, doctor failures, delete protection, file locations.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-06 17:44:25 -04:00