Skip to content

docs: improve README CLI documentation and structure#87

Merged
shinpr merged 2 commits intomainfrom
docs/cli-env-vars-readme
Mar 19, 2026
Merged

docs: improve README CLI documentation and structure#87
shinpr merged 2 commits intomainfrom
docs/cli-env-vars-readme

Conversation

@shinpr
Copy link
Owner

@shinpr shinpr commented Mar 19, 2026

Summary

  • Add low-poly mole banner with vector space dot cluster
  • Split Usage into "Using with MCP" / "Using as CLI" as equal entry points
  • Add CLI quick start path alongside MCP setup
  • Document CLI configuration with three patterns: flags, env vars, shared config
  • Add resolution order (CLI flags > env vars > defaults) with correct examples
  • Consolidate env var / CLI flag mapping table in Configuration section (no longer duplicated)
  • Warn explicitly that CLI does not read MCP client config files
  • Add "Agent reality" paragraph to Why This Exists, connecting CLI + Skills to real-world agent usage
  • Promote Configuration from collapsed <details> to a regular section for discoverability
  • Update tagline and Features to reflect MCP + CLI parity

Test plan

  • Verify banner image renders correctly on GitHub
  • Verify all internal anchor links work on GitHub (#agent-skills, #configuration)
  • Confirm Configuration section renders correctly (no longer inside <details>)
  • Check that collapsed sections (Performance, Troubleshooting, FAQ, Development) still render properly
  • Review CLI flag example matches documented global/subcommand option rules

🤖 Generated with Claude Code

shinpr and others added 2 commits March 19, 2026 18:24
- Split Usage into "Using with MCP" and "Using as CLI" sections
- Add CLI entry point to Quick Start
- Document CLI config: flags, env vars, and shared config patterns
- Add resolution order (CLI flags > env vars > defaults)
- Consolidate env var / CLI flag mapping table in Configuration section
- Warn that CLI does not read MCP client config
- Add "Agent reality" to Why This Exists
- Promote Configuration from collapsed details to regular section
- Update tagline and Features to reflect MCP + CLI parity

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Add low-poly mole banner with vector space dot cluster,
representing local document search (below the surface).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@shinpr shinpr self-assigned this Mar 19, 2026
@shinpr shinpr merged commit c190ca4 into main Mar 19, 2026
1 check passed
@shinpr shinpr deleted the docs/cli-env-vars-readme branch March 19, 2026 12:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant