Skip to content

AGENTS.md

Latest commit

 

History

History
73 lines (56 loc) · 2.64 KB

AGENTS.md

File metadata and controls

73 lines (56 loc) · 2.64 KB
Raw

OneKey Hardware SDK - Codex 文档指引

📚 Context7 文档支持

本项目已在 Context7 上索引，可通过 MCP 工具获取最新文档和代码示例：

{
  "url": "https://context7.com/onekeyhq/hardware-js-sdk",
  "library_id": "/onekeyhq/hardware-js-sdk"
}

使用方法：

  • 使用 mcp__context7__get-library-docs 工具获取文档
  • Library ID: /onekeyhq/hardware-js-sdk
  • 可指定 topic 参数聚焦特定主题，如 transport、signing、bip39 等

📁 问题分流指引

根据问题类型，请参考对应的专业文档：

🔌 连接与传输问题

症状: WebUSB权限错误、设备连接失败、传输超时

⛓️ 区块链集成问题

症状: 签名失败、地址生成错误、交易构建问题

🔐 助记词与密钥管理

症状: SLIP39恢复失败、密钥派生错误、种子生成问题

🏗️ 架构与开发问题

症状: 构建失败、依赖问题、monorepo结构疑问

🤖 AI Agent 集成 / CLI 使用

症状: CLI 命令使用、Agent Skill 配置、链支持查询

  • 📖 文档: developer-portal 的 agent-integration.mdx
  • 🔧 @onekeyfe/cli（onekey 命令）— 全功能钱包 CLI：auth login 选择登录方式（mnemonic / app-transfer / hardware），balance / transfer / swap / device ... 等业务命令登录后自动沿用该模式
  • 🔧 @onekeyfe/hardware-cli（onekey-hw 命令）— 纯硬件钱包 CLI，AI Agent 直连设备优先选它

如果你要通过 onekey CLI 使用硬件钱包：

npm install -g @onekeyfe/cli

# Step 1：登录时选择硬件模式（--hardware 只在 auth login 上有）
onekey auth login --hardware

# Step 2：登录后的业务命令不需要再加 flag，自动走硬件钱包
onekey balance --chain eth
onekey device search
onekey device firmware

如果要只调硬件操作、不走 onekey 账户体系（更轻、AI Agent 场景友好）：

npm install -g @onekeyfe/hardware-cli
onekey-hw search
onekey-hw get-address --chain evm --use-empty-passphrase

🤖 专业Agent

hardware-sdk-expert - 硬件SDK架构专家

  • 擅长：三层架构分析、WebUSB/BLE协议、BIP32/BIP39/SLIP39
  • 工作方式：优先查阅相关文档，然后进行代码分析