Skip to content

docs: add Trust Wallet Agent SDK documentation#405

Open
vcoolish-tw wants to merge 7 commits intomasterfrom
feat/agent-sdk-docs
Open

docs: add Trust Wallet Agent SDK documentation#405
vcoolish-tw wants to merge 7 commits intomasterfrom
feat/agent-sdk-docs

Conversation

@vcoolish-tw
Copy link
Contributor

Summary

  • Add Agent SDK docs section: overview, quickstart, CLI reference, authentication
  • Update README and SUMMARY with Agent SDK navigation entries

Test plan

  • Verify GitBook renders all four new pages correctly
  • Check internal links between Agent SDK pages resolve

developer.trustwallet.com was incorrect — the actual portal is at
portal.trustwallet.com. Also fixes /dashboard/keys to /dashboard/apps.
- Add missing wallet keychain subcommands (save/delete/check)
- Add missing --no-keychain flag to wallet create
- Mark --password optional where it falls back to keychain/env var
- Add --wc-project-id to auth setup
- Fix erc20 --token to use assetId format instead of address
- Package name: @trustwallet/cli (not @twak/cli)
- Remove tw-agent alias (no longer exists)
- Config dir: ~/.twak/ (not ~/.tw-agent/)
- Remove onramp, automate, walletconnect commands (disabled in public CLI)
- Add missing commands: portfolio, sign-message, dapps, trending categories
- Add transfer safety flags: --max-usd, --skip-safety-check, --confirm-to
- Add erc20 revoke, swap slippage cap, serve --auto-lock
- Fix API URL: tws.trustwallet.com (not api.trustwallet.com)
- Access IDs are plain hex, not twk_live_ prefixed
- Use real API path /v1/search/assets in auth example
- Remove wallet export (not a registered CLI command)
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new “Trust Wallet Agent SDK” documentation section to the GitBook, including an overview page plus user-facing guides for getting started, CLI usage, and authentication, and wires these pages into the existing navigation.

Changes:

  • Added four new Agent SDK documentation pages (overview, quickstart, CLI reference, authentication).
  • Updated GitBook navigation (SUMMARY) to include the new Agent SDK section.
  • Updated README to surface the Agent SDK docs entry points.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
agent-sdk/agent-sdk.md New overview/landing page for the Agent SDK docs section.
agent-sdk/quickstart.md New quickstart flow covering install, credentials, and first commands.
agent-sdk/cli-reference.md New CLI command/reference documentation for twak.
agent-sdk/authentication.md New authentication guide describing credential setup and HMAC signing.
SUMMARY.md Adds Agent SDK pages into the GitBook table of contents.
README.md Adds Agent SDK section with links to the new pages.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

- Add --confirm-to to transfer command synopsis
- Clarify REST server auth (Bearer token, not HMAC signing)
- Fix "three headers" → "four headers" in auth docs
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.

3 participants