Skip to content

Add docs/cli.md — public CLI reference#4

Open
pimfeltkamp wants to merge 3 commits intomainfrom
add-cli-doc
Open

Add docs/cli.md — public CLI reference#4
pimfeltkamp wants to merge 3 commits intomainfrom
add-cli-doc

Conversation

@pimfeltkamp
Copy link
Copy Markdown

Summary

Adds `docs/cli.md` as the single public doc covering the `cryptohopper` CLI. Pairs with `docs/sdks.md` (PR #3).

What it covers

  • Install: npm + platform-specific binary URLs + SHA256 verification
  • Authentication: browser flow, `--token` fallback, env overrides
  • Every subcommand with usage example
  • Confirmation gates (`--yes`) on destructive commands, including the 0.5.1 security fix documentation
  • Exit code table (stable contract across releases)
  • `--json` output contract
  • Upgrade command requirements (compiled binary only, not `node dist/index.js`)

Test plan

  • Render on GitHub; confirm the TOC flows
  • Verify every install command is accurate against the current release
  • Confirm the commands list matches src/index.ts (it does — sourced from the file directly)

pimfeltkamp and others added 2 commits April 25, 2026 00:27
Single-page doc covering install (npm + binary paths + SHA256 verify),
auth flow + env overrides, every command with example invocation,
confirmation-gate policy (and the 0.5.1 security fix around it), exit
codes, JSON output contract, and the upgrade command's requirements.

Cross-links to docs/sdks.md and VERSIONING.md.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Adds the 4 commands shipped in cli-v0.6.0-alpha.1: `exchange list`,
`exchange markets`, `strategy list`, `strategy get`.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Same false claim caught in the SDK READMEs and wikis: the API
gateway has no anonymous routes, so 'cryptohopper ticker' and
the other market-data subcommands still need a real token.
Removes the misleading parenthetical and adds a note explaining
why these are 'public' data but not 'public' API access.
@pimfeltkamp
Copy link
Copy Markdown
Author

Pushed a small follow-up commit that strikes ### Market data (public, no auth) from the heading and adds a 1-line clarification about why these are 'public' data but still need auth — same false-claim cleanup that just landed across the SDK READMEs and wikis from resources#9. Two-line README diff. No re-review beyond a skim.

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