feat(cli): status formatter + CLI gallery docs#56
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3368d5422e
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| "relatedMemories": ["Always use HttpInterceptorFn (0.97)"] | ||
| } | ||
| ``` | ||
| For scripting and automation, every CLI command accepts `--json` for machine output (stdout = JSON; logs/errors go to stderr). |
There was a problem hiding this comment.
Narrow the --json guarantee to commands that emit JSON
This new README contract says every CLI command produces machine JSON on stdout with --json, but the memory add/memory remove paths still always print plain text (Added.../Removed...) and never branch on --json (src/cli-memory.ts, add/remove branches). In automation, calling those subcommands with --json will return non-JSON output and break parsers, so the docs should either scope the promise to supported commands or the subcommands should implement JSON output.
Useful? React with 👍 / 👎.
Greptile SummaryAdded Key changes:
Confidence Score: 5/5
|
| Filename | Overview |
|---|---|
| src/cli-formatters.ts | Added status formatter with ASCII/Unicode glyph system for terminal compatibility - clean implementation with proper fallbacks |
| src/cli.ts | Added environment variable documentation and connected status command to formatter - minimal, focused changes |
| tests/cli.test.ts | Added test coverage for status command with proper environment variable cleanup - well-structured test |
| docs/cli.md | New CLI gallery documentation with clear examples and ASCII fallback instructions - comprehensive and well-organized |
| docs/capabilities.md | Updated CLI reference and documented impact.details field with backward compatibility note |
| README.md | Added CLI gallery preview section and improved documentation structure - formatting improvements and clearer onboarding flow |
Last reviewed commit: 3368d54
What / Why
Explain the change briefly.
Release notes
This repo uses an automated release flow.
feat: ...,fix: ...,docs: ...,chore: ...,refactor: ...