Clarify README CLI commands vs in-session skills#2200
Open
Yeachan-Heo wants to merge 2 commits intodevfrom
Open
Clarify README CLI commands vs in-session skills#2200Yeachan-Heo wants to merge 2 commits intodevfrom
Yeachan-Heo wants to merge 2 commits intodevfrom
Conversation
The README mixed terminal `omc ...` commands with in-session slash skills, which made features like autopilot and team look interchangeable. This change adds a compact surface guide, relabels the quick-start example as an in-session skill, pairs CLI and slash forms where the repo actually supports both, and documents the existing `omc autoresearch` CLI path. Constraint: Keep scope tight to README accuracy for issue #2198 Rejected: Broad README rewrite | unnecessary risk and churn for a documentation fix Confidence: high Scope-risk: narrow Reversibility: clean Directive: When documenting OMC features, verify whether the surface is terminal CLI, in-session skill, or both before adding examples Tested: node bridge/cli.cjs --help; AUTORESEARCH_HELP from dist/cli/autoresearch.js; npm run test:run -- src/cli/__tests__/cli-boot.test.ts src/cli/__tests__/autoresearch.test.ts src/__tests__/auto-slash-aliases.test.ts; npx tsc --noEmit Not-tested: Full vitest suite; lint warning cleanup in unrelated existing test file
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
Issue #2198 asked for tighter documentation around which entrypoints are real `omc` CLI commands versus in-session skills and prompt triggers. The current README already covered most of the distinction, but the shortcuts table still mixed a terminal example into the in-session section and did not label slash skills versus prompt triggers consistently. This narrows the README copy to the actual runtime surfaces verified in the repo: in-session shortcuts now stay session-only, Team is called out as explicit on both surfaces, and the table shows slash-skill versus prompt-trigger forms without implying extra CLI subcommands. Constraint: Keep scope limited to documentation accuracy; no runtime changes Rejected: Broad README rewrite | unnecessary churn for a small docs issue Confidence: high Scope-risk: narrow Reversibility: clean Directive: When documenting OMC entrypoints, verify terminal `omc ...` commands in `src/cli/index.ts` and session surfaces in `skills/*/SKILL.md` or slash-command runtime code before adding examples Tested: node bridge/cli.cjs --help; node bridge/cli.cjs autoresearch --help; npm test -- --run src/cli/__tests__/autoresearch.test.ts src/cli/__tests__/autoresearch-guided.test.ts src/__tests__/auto-slash-aliases.test.ts src/cli/__tests__/team-help.test.ts src/cli/__tests__/ask.test.ts Not-tested: Localized README variants
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
omc ...commands from in-session/...skillsomcsubcommandsomc autoresearchCLI surface and its/deep-interview --autoresearch ...handoffCloses #2198
Verification
node bridge/cli.cjs --helpnode - <<'NODE' ... AUTORESEARCH_HELP ... NODEnpm run test:run -- src/cli/__tests__/cli-boot.test.ts src/cli/__tests__/autoresearch.test.ts src/__tests__/auto-slash-aliases.test.tsnpx tsc --noEmitNotes
npm run lintstill reports one pre-existing warning insrc/hooks/setup/__tests__/stdin-symlink.test.ts