Skip to content

docs: add hardware CLI usage guide#777

Draft
cursor[bot] wants to merge 1 commit into
onekeyfrom
cursor/codebase-documentation-alignment-85ea
Draft

docs: add hardware CLI usage guide#777
cursor[bot] wants to merge 1 commit into
onekeyfrom
cursor/codebase-documentation-alignment-85ea

Conversation

@cursor
Copy link
Copy Markdown

@cursor cursor Bot commented Apr 27, 2026

Summary

  • add a repository-local README for @onekeyfe/hardware-cli
  • link the new CLI guide from the root README.md and docs/architecture.md
  • document verified CLI runtime behavior, common workflows, and troubleshooting notes

Docs updated

  • packages/hd-cli/README.md
  • README.md
  • docs/architecture.md

Codepaths covered

  • packages/hd-cli/src/cli.ts
  • packages/hd-cli/src/sdk.ts
  • packages/hd-cli/src/session.ts
  • packages/hd-cli/src/chains.ts
  • packages/hd-cli/src/pinentry.ts
  • packages/hd-cli/src/storage/*

Knowledge gaps addressed

  • where onekey-hw fits in the monorepo and when to use it
  • how the CLI handles Node USB transport, stdout/stderr output, and interactive prompts
  • how hidden-wallet session caching works on macOS and Linux
  • common constraints such as firmware-update stubs, non-TTY passphrase fallback, and Linux secret-tool requirements
Open in Web View Automation 

Co-authored-by: Leon <lixiao.dev@gmail.com>
@revan-zhang
Copy link
Copy Markdown
Contributor

revan-zhang commented Apr 27, 2026

Snyk checks have passed. No issues have been found so far.

Status Scan Engine Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

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.

2 participants