Docs/cli overview top level index #990
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| --- | ||
| sidebar_label: Farmer | ||
| title: Farmer CLI | ||
| slug: /reference-client/cli-reference/farmer-cli | ||
| --- | ||
|
|
||
| Commands that query or configure **farming** and **pooling** through the farmer and wallet RPC clients. Default farmer RPC port **8559** (`farmer.rpc_port`). For JSON-RPC reference, see [Farmer RPC](/reference-client/rpc-reference/farmer-rpc). | ||
|
|
||
| Sources: [`chia/cmds/farm.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/farm.py), [`chia/cmds/plotnft.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/plotnft.py). | ||
|
|
||
| ## `chia farm` | ||
|
|
||
| ### `chia farm summary` | ||
|
|
||
| Usage: `chia farm summary [OPTIONS]` | ||
|
|
||
| Prints farming status: blockchain sync (via full node), harvester summaries, plot counts, and estimated rewards when services are reachable. | ||
|
|
||
| | Option | Description | | ||
| | :----------------------------- | :------------------------------------------------ | | ||
| | `-p`, `--rpc-port` | Full node RPC port. | | ||
| | `-wp`, `--wallet-rpc-port` | Wallet RPC port. | | ||
| | `-hp`, `--harvester-rpc-port` | Harvester RPC port (local harvester). | | ||
| | `-fp`, `--farmer-rpc-port` | Farmer RPC port. | | ||
| | `-i`, `--include-pool-rewards` | Include pool farming rewards in displayed totals. | | ||
|
Contributor
Author
There was a problem hiding this comment. need an example added
Contributor
Author
There was a problem hiding this comment. the example does not contain the example output...make sure your skill is updated to include the proper template for these and that all are verified against that template |
||
|
|
||
| ### `chia farm challenges` | ||
|
|
||
| Usage: `chia farm challenges [OPTIONS]` | ||
|
|
||
| Shows recent signage point challenges from the farmer. | ||
|
|
||
| | Option | Description | | ||
| | :------------------------- | :------------------------------------------------ | | ||
| | `-fp`, `--farmer-rpc-port` | Farmer RPC port. | | ||
| | `-l`, `--limit` | Max challenges to print (`0` disables the limit). | | ||
|
|
||
| ### `chia farm connect-solver` {#chia-farm-connect-solver} | ||
|
|
||
| Usage: `chia farm connect-solver [OPTIONS] SOLVER_ADDRESS` | ||
|
|
||
| Points the farmer at a **Solver** service (`host:port`). Solver integration is also configurable via farmer RPC (see `connect_to_solver` on [Farmer RPC](/reference-client/rpc-reference/farmer-rpc)) and [Solver CLI](/reference-client/cli-reference/solver-cli). | ||
|
|
||
| | Option | Description | | ||
| | :------------------------- | :--------------- | | ||
| | `-fp`, `--farmer-rpc-port` | Farmer RPC port. | | ||
|
|
||
| ## Plot NFT {#plot-nft} | ||
|
|
||
| Usage: `chia plotnft [OPTIONS] COMMAND` | ||
|
|
||
| Plot NFT commands use the **wallet** RPC (pooling operations). Run `chia plotnft -h` for the full subcommand list; common commands include: | ||
|
|
||
| | Command | Purpose | | ||
| | :--------------- | :------------------------------------------------------------ | | ||
| | `show` | Show plot NFT and pool state (launcher id, pool URL, points). | | ||
| | `create` | Create a plot NFT (pool URL or self-farming). | | ||
| | `join` / `leave` | Switch pools or return to self-farming. | | ||
| | `claim` | Claim pool rewards. | | ||
| | `inspect` | Detailed plot NFT JSON. | | ||
| | `get_login_link` | Pool login link (needs launcher id from `plotnft show`). | | ||
|
|
||
| Examples: | ||
|
Contributor
Author
There was a problem hiding this comment. examples should match how they are on the rpc docs, not added as afterthoughts |
||
|
|
||
| - Create a plot NFT on a pool: `chia plotnft create -u https://pool.example.com` | ||
| - Self-farming plot NFT: `chia plotnft create -s local` | ||
| - When plotting to a pool contract, use the **pool contract address** from `chia plotnft show` with your plotting command (`-c` instead of legacy `-p` for pool public key). | ||
|
|
||
| ## Related | ||
|
|
||
| - [CLI overview](/reference-client/cli-reference/cli) | ||
| - [Harvester CLI](/reference-client/cli-reference/harvester-cli) | ||
| - [Solver CLI](/reference-client/cli-reference/solver-cli) | ||
| - [Wallet CLI](/reference-client/cli-reference/wallet-cli) | ||
| - [Farmer RPC](/reference-client/rpc-reference/farmer-rpc) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| --- | ||
| sidebar_label: Full Node | ||
| title: Full Node CLI | ||
| slug: /reference-client/cli-reference/full-node-cli | ||
| --- | ||
|
|
||
| Commands that talk to the **full node** use its RPC interface (default port **8555**, configurable under `full_node.rpc_port` in `config.yaml`). For HTTP JSON-RPC methods, see [Full Node RPC](/reference-client/rpc-reference/full-node-rpc). | ||
|
BrandtH22 marked this conversation as resolved.
Outdated
|
||
|
|
||
| Sources: [`chia/cmds/show.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/show.py), [`chia/cmds/netspace.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/netspace.py), [`chia/cmds/peer.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/peer.py). | ||
|
|
||
| ## `chia show` | ||
|
|
||
| Usage: `chia show [OPTIONS]` | ||
|
|
||
| Shows blockchain and fee information via the full node. At least one option is required (`no_args_is_help`). | ||
|
|
||
| | Option | Description | | ||
| | :------------------------------------- | :---------------------------------------------------------------------- | | ||
| | `-p`, `--rpc-port` | Full node RPC port (see `full_node.rpc_port` in `config.yaml`). | | ||
| | `-f`, `--fee` | Show fee information. | | ||
| | `-s`, `--state` | Show current blockchain state (sync height, peak hash, recent headers). | | ||
| | `-bh`, `--block-header-hash-by-height` | Look up a block header hash by height (`INTEGER`). | | ||
| | `-b`, `--block-by-header-hash` | Look up a block by header hash (`TEXT`). | | ||
|
|
||
| :::note Legacy `chia show` connection flags | ||
|
|
||
| `-c` / `--connections`, `-a` / `--add-connection`, and `-r` / `--remove-connection` still parse but print a message directing you to **`chia peer full_node`** instead. `-wp` / `--wallet-rpc-port` prints a message that it is unused. | ||
|
|
||
| ::: | ||
|
|
||
| ## `chia netspace` | ||
|
|
||
| Usage: `chia netspace [OPTIONS]` | ||
|
|
||
| Estimates total network space from full node chain data. | ||
|
|
||
| | Option | Description | | ||
| | :--------------------------- | :---------------------------------------------------------------------------------------------- | | ||
| | `-p`, `--rpc-port` | Full node RPC port. | | ||
| | `-d`, `--delta-block-height` | Block spacing for the estimate (default `4608`, about one day). Use `192` for roughly one hour. | | ||
| | `-s`, `--start` | Newest block height to anchor the calculation (default: peak). | | ||
|
|
||
| ## `chia peer full_node` | ||
|
|
||
| Usage: `chia peer full_node [OPTIONS]` | ||
|
|
||
| Inspect or change **full node** peer connections (same RPC service as `chia show`). | ||
|
|
||
| | Option | Description | | ||
| | :-------------------------- | :------------------------------------------------------------- | | ||
| | `-p`, `--rpc-port` | RPC port for the service you are addressing (here: full node). | | ||
| | `-c`, `--connections` | List peers connected to this full node. | | ||
| | `-a`, `--add-connection` | Connect to another node `ip:port`. | | ||
| | `-r`, `--remove-connection` | Remove a peer by the first **8 characters** of its node id. | | ||
|
|
||
| Other `chia peer <node_type>` targets (`farmer`, `wallet`, `harvester`, `data_layer`, `simulator`, `solver`) are documented on [Farmer CLI](/reference-client/cli-reference/farmer-cli), [Harvester CLI](/reference-client/cli-reference/harvester-cli), and related pages as applicable. | ||
|
|
||
| ## Related | ||
|
|
||
| - [CLI overview](/reference-client/cli-reference/cli) | ||
| - [RPC overview](/reference-client/rpc-reference/rpc) | ||
| - [Full Node RPC](/reference-client/rpc-reference/full-node-rpc) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| --- | ||
| sidebar_label: Harvester | ||
| title: Harvester CLI | ||
| slug: /reference-client/cli-reference/harvester-cli | ||
| --- | ||
|
|
||
| There is no separate top-level `chia harvester` group: the harvester is started with `chia start harvester` (see [CLI overview](/reference-client/cli-reference/cli), section **start**) or bundled inside groups such as `farmer`. Operations below use the **harvester RPC** (default port **8560**, `harvester.rpc_port`) or update plot directories that the harvester reads from `config.yaml`. | ||
|
|
||
| For HTTP JSON-RPC methods, see [Harvester RPC](/reference-client/rpc-reference/harvester-rpc). | ||
|
|
||
| Sources: [`chia/cmds/peer.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/peer.py), [`chia/cmds/plots.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/plots.py), [`chia/cmds/init.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/init.py), [`chia/cmds/configure.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/configure.py). | ||
|
|
||
| ## `chia peer harvester` | ||
|
|
||
|
BrandtH22 marked this conversation as resolved.
|
||
| Usage: `chia peer harvester [OPTIONS]` | ||
|
|
||
| | Option | Description | | ||
| | :-------------------------- | :-------------------------------------------------- | | ||
| | `-p`, `--rpc-port` | Harvester RPC port. | | ||
| | `-c`, `--connections` | List connections for this harvester. | | ||
| | `-a`, `--add-connection` | Add a connection `ip:port`. | | ||
| | `-r`, `--remove-connection` | Remove a peer by the first 8 characters of node id. | | ||
|
|
||
| ## Plot directories (harvester) | ||
|
|
||
| The harvester loads plot search paths from configuration. Use the **`chia plots`** commands on the [CLI overview](/reference-client/cli-reference/cli) (`show`, `add`, `remove`, `check`) to manage directories. `chia plots add -d` / `remove -d` update the same list the harvester uses when farming. | ||
|
|
||
| ## Remote harvester | ||
|
|
||
| To run a **remote** harvester that connects to your farmer: | ||
|
|
||
| 1. Copy CA / certificate material per upstream `chia init` instructions (see **`chia init -h`** and [`chia/cmds/init.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/init.py) comments). | ||
|
BrandtH22 marked this conversation as resolved.
Outdated
|
||
| 2. On the harvester machine, point SSL and farmer connection settings at your farmer. | ||
| 3. Use **`chia configure --set-farmer-peer IP:Port`** on the harvester side so it knows the farmer (see **configure** on the [CLI overview](/reference-client/cli-reference/cli)). | ||
|
|
||
| After certificate and peer configuration changes, restart affected services. | ||
|
|
||
| ## `chia rpc harvester` | ||
|
BrandtH22 marked this conversation as resolved.
Outdated
|
||
|
|
||
| Shell JSON-RPC calls follow the same pattern as other services (see [RPC overview](/reference-client/rpc-reference/rpc)): | ||
|
|
||
| ```bash | ||
| chia rpc harvester <method> '<json>' | ||
| ``` | ||
|
|
||
| Method names and payloads match [Harvester RPC](/reference-client/rpc-reference/harvester-rpc). | ||
|
|
||
| ## Related | ||
|
|
||
| - [CLI overview](/reference-client/cli-reference/cli) | ||
| - [Farmer CLI](/reference-client/cli-reference/farmer-cli) | ||
| - [Harvester RPC](/reference-client/rpc-reference/harvester-rpc) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| --- | ||
| sidebar_label: Solver | ||
| title: Solver CLI | ||
| slug: /reference-client/cli-reference/solver-cli | ||
| --- | ||
|
|
||
| The **Solver** service accepts JSON-RPC over TLS on port **8667** by default (`solver.rpc_port` in `config.yaml`). Method-level HTTP RPC documentation is on [Solver RPC](/reference-client/rpc-reference/solver-rpc). Call methods from the shell with `chia rpc solver <method> '<json>'` like other services (see [RPC overview](/reference-client/rpc-reference/rpc)). | ||
|
BrandtH22 marked this conversation as resolved.
Outdated
|
||
|
|
||
| Sources: [`chia/cmds/solver.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/solver.py). | ||
|
|
||
| ## `chia solver` | ||
|
|
||
| ### `chia solver get_state` | ||
|
|
||
| Usage: `chia solver get_state [OPTIONS]` | ||
|
|
||
| Returns current solver state from the running Solver service. | ||
|
|
||
| | Option | Description | | ||
| | :------------------------- | :-------------------------------------------------------- | | ||
| | `-sp`, `--solver-rpc-port` | Solver RPC port (see `solver.rpc_port` in `config.yaml`). | | ||
|
|
||
| ## Farmer integration | ||
|
|
||
| - CLI: [`chia farm connect-solver`](/reference-client/cli-reference/farmer-cli#chia-farm-connect-solver) | ||
| - RPC: `connect_to_solver` and related calls on [Farmer RPC](/reference-client/rpc-reference/farmer-rpc) | ||
| - Config: `chia configure --set-solver-peer` and farmer `solver_peers` (see **configure** on the [CLI overview](/reference-client/cli-reference/cli)) | ||
|
|
||
| ## Related | ||
|
|
||
| - [CLI overview](/reference-client/cli-reference/cli) | ||
| - [Farmer CLI](/reference-client/cli-reference/farmer-cli) | ||
| - [Solver RPC](/reference-client/rpc-reference/solver-rpc) | ||
| - [RPC overview](/reference-client/rpc-reference/rpc) | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why all the bold?