Skip to content

docs: add hardware CLI README#811

Draft
cursor[bot] wants to merge 1 commit into
onekeyfrom
cursor/engineering-documentation-updates-aff0
Draft

docs: add hardware CLI README#811
cursor[bot] wants to merge 1 commit into
onekeyfrom
cursor/engineering-documentation-updates-aff0

Conversation

@cursor

@cursor cursor Bot commented Jun 1, 2026

Copy link
Copy Markdown

Summary

  • add a package README for @onekeyfe/hardware-cli
  • document the public onekey-hw command surface, runtime model, and JSON output contract
  • cover hidden-wallet session reuse, secure storage backends, and command limitations

Codepaths covered

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

Knowledge gaps addressed

  • there was no package-level README for the published hardware CLI
  • the session caching flow and OS storage dependencies were undocumented
  • developers did not have a single source for command groups, parameter pitfalls, and unsupported firmware-update behavior

Validation

  • documentation-only change; verified statements against the current source files
Open in Web View Automation 

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

revan-zhang commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

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