Skip to content

Latest commit

 

History

History
179 lines (154 loc) · 8.57 KB

File metadata and controls

179 lines (154 loc) · 8.57 KB

Command Reference

Every command — including every subcommand — has its own page, following a fixed layout (Synopsis · Description · Options · Examples · Output · Exit status · See also). Command-group pages list and link their subcommands.

Wallets and accounts

Command Page
create create.md
import (group) import/index.md
import mnemonic import/mnemonic.md (interactive-only)
import private-key import/private-key.md (interactive-only)
import keystore import/keystore.md (interactive-only)
import ledger import/ledger.md
import watch import/watch.md
list list.md
use use.md
current current.md
derive derive.md
rename rename.md
backup backup.md
delete delete.md
change-password change-password.md

Transactions

Command Page
tx (group) tx/index.md
tx send tx/send.md
tx broadcast tx/broadcast.md
tx status tx/status.md
tx info tx/info.md
tx sign tx/sign.md
tx approvals tx/approvals.md
tx multisig tx/multisig.md

On-chain queries

Command Page
account (group) account/index.md
account balance account/balance.md
account info account/info.md
account history account/history.md
account portfolio account/portfolio.md
account activate account/activate.md
account set account/set.md
block block.md
chain (group) chain/index.md
chain params chain/params.md
chain prices chain/prices.md
chain node chain/node.md

Account permissions

Command Page
permission (group) permission/index.md
permission show permission/show.md
permission update permission/update.md

Tokens and contracts

Command Page
token (group) token/index.md
token balance token/balance.md
token info token/info.md
token add token/add.md
token list token/list.md
token remove token/remove.md
contact (group) contact/index.md
contact add contact/add.md
contact list contact/list.md
contact remove contact/remove.md
contract (group) contract/index.md
contract call contract/call.md
contract send contract/send.md
contract deploy contract/deploy.md
contract info contract/info.md
contract clear-abi contract/clear-abi.md
contract set-origin-energy-limit contract/set-origin-energy-limit.md
contract set-user-resource-percent contract/set-user-resource-percent.md
contract create2 contract/create2.md
gasfree (group) gasfree/index.md
gasfree info gasfree/info.md
gasfree transfer gasfree/transfer.md
gasfree trace gasfree/trace.md

Staking, voting, rewards

Command Page
stake (group) stake/index.md
stake freeze stake/freeze.md
stake unfreeze stake/unfreeze.md
stake withdraw stake/withdraw.md
stake cancel-unfreeze stake/cancel-unfreeze.md
stake delegate stake/delegate.md
stake undelegate stake/undelegate.md
stake info stake/info.md
stake delegated stake/delegated.md
vote (group) vote/index.md
vote cast vote/cast.md
vote list vote/list.md
vote status vote/status.md
reward (group) reward/index.md
reward balance reward/balance.md
reward withdraw reward/withdraw.md

Governance

Command Page
proposal (group) proposal/index.md
proposal list proposal/list.md
proposal show proposal/show.md
proposal create proposal/create.md
proposal approve proposal/approve.md
proposal delete proposal/delete.md
witness (group) witness/index.md
witness create witness/create.md
witness update witness/update.md
witness set-brokerage witness/set-brokerage.md

TRC10 assets and the on-chain exchange

Command Page
asset (group) asset/index.md
asset issue asset/issue.md
asset update asset/update.md
asset participate asset/participate.md
asset unfreeze asset/unfreeze.md
asset info asset/info.md
asset list asset/list.md
exchange (group) exchange/index.md
exchange create exchange/create.md
exchange inject exchange/inject.md
exchange withdraw exchange/withdraw.md
exchange trade exchange/trade.md
exchange show exchange/show.md
exchange list exchange/list.md

Signing

Command Page
message (group) message/index.md
message sign message/sign.md
typed-data (group) typed-data/index.md
typed-data sign typed-data/sign.md

Local

Command Page
encoding (group) encoding/index.md
encoding convert encoding/convert.md
address (group) address/index.md
address generate address/generate.md
config config.md
networks networks.md

Global options (every command)

-o, --output <text|json>   result format (default: config.defaultOutput, built-in text)
--network <string>         canonical network id (chain commands; falls back to config.defaultNetwork)
--account <string>         accountId, label, or address (wallet-bound commands; falls back to active)
--timeout <number>         per RPC/device call timeout, ms (default: config.timeoutMs, built-in 60000)
-v, --verbose              extra diagnostic output
-h, --help / -V, --version

Broadcast (✍️) commands additionally take --wait / --wait-timeout <ms> (cap default: config waitTimeoutMs, built-in 60000), the early-exit modes --dry-run / --sign-only / --build-only, and the multi-sig options --permission-id <n> / --expiration <ms>.

The three early-exit modes are mutually exclusive, and --expiration is accepted only alongside --sign-only or --build-only. Breaking either rule is a usage error at exit 2. The code depends on where the check runs: on the governance and asset/exchange writes it is invalid_value, and the message names the field as --input rather than the flags you passed — for example invalid --input: choose at most one of --dry-run, --sign-only, --build-only. Elsewhere the same conflict reports invalid_option. Branch on the exit code, not on the code string; see machine interface.