# OpenSeed CLI
The OpenSeed Command-Line Interface (CLI) is the primary operational interface for advanced users who prefer terminal workflows, need to integrate OpenSeed operations into scripts and automation pipelines, or are operating Seller nodes in headless server environments where a graphical Dashboard is impractical. The CLI exposes the full functionality of the openseed-sdk through a clean, composable command structure that follows standard Unix conventions and integrates naturally into any shell environment.
### Overview and Design Philosophy
The CLI is designed around the principle of composability. Every command produces machine-readable output (JSON by default, with a human-readable flag for interactive use) that can be piped into other commands, redirected to files, or consumed by monitoring scripts. Every configuration parameter that can be set in a configuration file can also be overridden via command-line flags, allowing for flexible per-invocation customization.
The CLI is distributed as a standalone binary for Linux, macOS, and Windows, requiring no runtime dependencies. It is also available as an npm package for environments where Node.js is already present. Installation is a single command, and the CLI is usable immediately after installation with no additional setup beyond providing your wallet credentials.
The CLI is organized into command groups that mirror the architecture of the OpenSeed system: node management commands for starting and stopping Buyer and Seller nodes; wallet commands for managing balances and credentials; channel commands for managing payment channels and authorizations; registry commands for querying the network's peer list; settlement commands for converting earnings to USDC; and analytics commands for inspecting usage history and performance metrics.
### Command Groups and Capabilities
The following command groups are available in the OpenSeed CLI. Each group contains multiple subcommands with their own flags and options. The full parameter reference for each command is available through the built-in help system.
The node group manages the lifecycle of Buyer and Seller nodes — starting, stopping, restarting, and checking the status of running nodes. It also handles configuration validation, log output management, and process supervision for long-running nodes.
The wallet group handles all wallet-related operations — creating new wallets, importing existing wallets from private keys or keystore files, checking USDC and ETH balances on Base Mainnet, and generating the addresses needed for funding.
The channel group provides visibility into and control over payment channels. Commands in this group show open channels, their current balances and utilization, pending SpendingAuths, and channel expiration times. Channel operations such as manual top-up and channel close are also accessible through this group.
The registry group provides access to the OpenSeed peer discovery network. Commands query the Registry for active Sellers matching specified criteria, show detailed information about specific nodes, and provide market pricing data for available models.
The settlement group handles the conversion of accumulated SpendingAuth signatures to realized USDC. Commands in this group show your current unrealized earnings, estimate the gas cost of a settlement transaction at the current accumulation level, and submit settlement transactions to Base Mainnet.
The analytics group provides access to usage history and performance data. Commands show historical request logs, spending by time period and by provider, reputation score history for Seller nodes, and comparative performance metrics.
\[Full CLI command reference with syntax, flags, options, and example outputs will be documented here for each command group and subcommand]
### Integration with Shell Environments and Scripts
The CLI's JSON output mode and composable design make it a natural fit for integration into shell scripts, cron jobs, monitoring systems, and automation pipelines.
Common automation patterns include scheduled settlement scripts that check unrealized earnings and submit settlement transactions when the balance exceeds a threshold; monitoring scripts that query node status and reputation metrics and send alerts when metrics fall below acceptable levels; balance management scripts that check USDC balance and trigger top-up alerts or automatic funding operations; and reporting scripts that aggregate usage data from the analytics group into custom reports or dashboards.
\[Example shell script patterns and integration templates will be documented here]
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.openseed.gg/integrations/openseed-cli.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.