Page is under construction.
Feedback Welcome!
Feedback Welcome!
Livepeer CLI Commands
CLI Tools Codebase
View CLI Tools Codebase on Github
Quick Reference
| Category | Commands | Node Type |
|---|---|---|
| General | Get node status, View protocol parameters, List orchestrators, Initialize round | All |
| Gateway/Broadcaster | Set broadcast config, Set max price per capability, Deposit/withdraw funds | Gateway |
| Orchestrator | Activate orchestrator, Set config, Set price, Call reward, Vote | Orchestrator |
| Ethereum | Transfer tokens, Set gas prices, Request test tokens, Sign message | All (on-chain) |
| Staking | Bond, Unbond, Rebond, Withdraw stake/fees | All |
Detailed Command List
General Commands (All Node Types)
- Get node status - Display node information, balances, and configuration
- View protocol parameters - Show protocol state and parameters
- List registered orchestrators - Display available orchestrators
- Initialize round - Initialize a new protocol round
Gateway/Broadcaster Commands
- Set broadcast config - Configure transcoding options and max price
- Set max price per capability - Set pricing for AI capabilities
- Deposit broadcasting funds - Add ETH for paying orchestrators
- Unlock broadcasting funds - Unlock deposited funds
- Withdraw broadcasting funds - Withdraw unlocked funds
Orchestrator Commands
- Activate orchestrator - Multi-step process to become an orchestrator
- Set orchestrator config - Update price, reward cut, fee share, service URI
- Invoke reward - Claim orchestrator rewards for current round
- Set max ticket face value - Configure maximum ticket value
- Set price for broadcaster - Set specific price for a broadcaster
- Set maximum sessions - Limit concurrent transcoding sessions
- Vote in governance poll - Participate in protocol governance
- Vote on treasury proposal - Vote on treasury proposals
Staking and Token Commands
- Bond tokens - Delegate LPT to an orchestrator
- Unbond tokens - Remove delegated tokens (starts unbonding period)
- Rebond tokens - Rebond tokens in unbonding state
- Withdraw stake - Withdraw completed unbonding stake
- Withdraw fees - Withdraw earned fees (ETH)
- Transfer tokens - Transfer LPT to another address
Ethereum Operations
- Set maximum gas price - Configure max gas for transactions
- Set minimum gas price - Configure min gas for transactions
- Get test LPT - Request test tokens (testnet only)
- Get test ETH - Instructions for testnet ETH faucet
- Sign message - Sign message with node’s private key
- Sign typed data - Sign EIP-712 typed data
HTTP API Endpoints
The CLI commands map to HTTP endpoints on the CLI server (default port 5935) :/status- Node status/protocolParameters- Protocol info/registeredOrchestrators- Orchestrator list/bond,/unbond,/rebond- Staking operations/activateOrchestrator- Orchestrator activation/setBroadcastConfig- Broadcast configuration/setMaxPriceForCapability- AI pricing/reward- Claim rewards/transferTokens- Token transfers/signMessage- Message signing
Notes
- Commands are filtered based on node type - some only appear for orchestrators or gateways
- Testnet commands (like getting test tokens) only appear on test networks
- The CLI connects to the node’s HTTP API, typically on port 5935 for gateways and 7935 for orchestrators