Skip to content

cli-spec.md

Latest commit

 

History

History
112 lines (76 loc) · 2.32 KB

cli-spec.md

File metadata and controls

112 lines (76 loc) · 2.32 KB

CLI specification

cmtk is a local-first command line tool for turning common maintainer inputs into Codex-ready workflows.

Global behavior

  • Input is read from a file path, -, or stdin when the path is omitted.
  • Output defaults to Markdown.
  • --format json wraps the Markdown output in a JSON object for scripts.
  • --format rich renders Markdown in terminals that support Rich formatting.
  • No network calls, API tokens, repository secrets, or private platform credentials are required for the MVP.

Commands

cmtk issue [PATH]

Purpose: triage an issue report into a maintainer checklist and Codex task seed.

Example:

cmtk issue examples/issue-input.md

Output includes:

  • issue type estimate
  • priority estimate
  • reproducibility checklist
  • Codex-ready task brief
  • maintainer reply draft

cmtk pr [PATH]

Purpose: summarize a unified PR diff into review risks and a Codex review prompt.

Example:

git diff main...HEAD | cmtk pr -

Output includes:

  • changed file summary
  • additions/deletions count
  • initial risk estimate
  • review checklist
  • Codex review prompt
  • visual QA checklist when UI/component files are changed

cmtk visual [PATH]

Purpose: turn a screenshot-driven visual/layout bug report into a scoped repair brief.

Example:

cmtk visual examples/visual-bug.md

Output includes:

  • visual bug goal
  • context excerpt
  • likely component/CSS/media inspection targets
  • screenshot QA checklist
  • browser verification steps
  • Codex implementation guardrails

cmtk release [PATH]

Purpose: turn git log text into draft release notes and a pre-tag checklist.

Example:

git log --oneline v0.1.0..HEAD | cmtk release -

Output includes:

  • features
  • fixes
  • docs
  • other changes
  • maintainer release checklist

cmtk codex-task [PATH] --mode implementation|review|docs|release

Purpose: convert maintainer context into a bounded Codex task brief.

Example:

cmtk codex-task examples/issue-input.md --mode implementation

Output includes:

  • goal
  • context excerpt
  • step-by-step Codex instructions
  • definition of done
  • suggested Codex CLI command

MVP limits

  • Heuristic parsing only.
  • No GitHub API integration in the MVP.
  • No automatic posting, merging, or release publishing.
  • Human maintainers review, edit, and approve all outputs.