From c3d83191fbc873854d8b478984e213d18ac34104 Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Wed, 6 May 2026 14:38:09 -0600 Subject: [PATCH 01/19] docs(cli): add top-level command index to CLI overview Enumerate every root CLI group from chia/cmds/chia.py with summary and pointer (section, topic page, or -h). Replace underspecified Other commands section. Use explicit heading ids for in-page links. zh-Hans updates are left to Crowdin/l10n automation. Fixes https://github.com/Chia-Network/chia-docs/issues/477 Co-authored-by: Cursor --- docs/reference-client/cli-reference/cli.md | 69 ++++++++++++++++------ 1 file changed, 52 insertions(+), 17 deletions(-) diff --git a/docs/reference-client/cli-reference/cli.md b/docs/reference-client/cli-reference/cli.md index ef029b4629..640c2b9251 100644 --- a/docs/reference-client/cli-reference/cli.md +++ b/docs/reference-client/cli-reference/cli.md @@ -25,7 +25,7 @@ Some examples: As with the rest of this project, this doc is a work-in-progress. Feel free to browse the [source code](https://github.com/Chia-Network/chia-blockchain/tree/main/chia/cmds) or the [Chia Proof of Space Construction Document](https://www.chia.net/assets/Chia_Proof_of_Space_Construction_v1.1.pdf) for more insight in the meantime. -## Related CLI references +## Related CLI references {#related-cli-references} This page is an overview. Deeper command documentation lives in topic pages, for example: @@ -75,7 +75,9 @@ If installed for all users, a common location is: C:\Program Files\Chia\resources\app.asar.unpacked\daemon\chia.exe ``` -# [init](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/init.py) +## init {#init} + +Source: [`chia/cmds/init.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/init.py) Command: `chia init` @@ -93,7 +95,7 @@ If no old version exists, `init`: - Creates a default Chia configuration - Initializes a new SSL key and cert (for secure communication with the GUI) -# start +## start {#start} Command: `chia start [OPTIONS] GROUP [GROUP ...]` @@ -130,12 +132,12 @@ Pass one or more **service group** names. The exact mapping is defined in the re | `seeder` | Crawler and seeder | | `seeder-only` | Seeder only | -# plotters +## plotters {#plotters} The reference client supports several plotters (including third-party and compressed-plot options). Each plotter has slightly different hardware requirements and may need slightly different options specified. The cli reference for all plotters can be found in the [Plotters CLI Page](/reference-client/cli-reference/plotter-cli). Learn more about the alternative plotters in the [Alternative Plotters page](/reference-client/plotting/plotting-software). -## plotnft +## plotnft {#plotnft} Using the CLI, you can perform the same operations as with the GUI. There is a new command, called `chia plotnft`. Type `chia plotnft -h` to see all the available sub-commands: @@ -162,7 +164,7 @@ To create a Plot NFT, use `chia plotnft create -u https://poolnamehere.com`, ent To switch pools, you can use `chia plotnft join`, and to leave a pool (switch to self farming), use `chia plotnft leave`. The `show` command can be used to check your current points balance. CLI plotting with `create_plots` is the same as before, but the `-p` is replaced with `-c`, and the pool contract address from `chia plotnft show` should be used here. -## [Plots check](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/plotting/check_plots.py) +## [Plots check](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/plotting/check_plots.py) {#plots-check} Command: `chia plots check -n [num checks] -l -g [substring]` @@ -207,7 +209,7 @@ The plots check challenge is a static challenge. For example if you run a plots **In theory**, a plot with a ratio >> 1 would be more likely to win challenges on the blockchain. Likewise, a plot with a ratio \<< 1 would be less likely to win. However, in practice, this isn't actually going to be noticeable. Therefore, don't worry if your plot check ratios are less than 1, unless they're _significantly_ less than 1 for _many_ `-n`. -# db +## db {#db} ## [upgrade](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/db.py) @@ -263,7 +265,7 @@ Command: `chia db validate [add flags and parameters]` - You do not need to stop your Chia node while performing the upgrade. - This will start by processing the latest block and traverse to the first block. -# keys +## keys {#keys} ## [derive](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/keys.py) @@ -368,7 +370,7 @@ See our [official NFT reference](/reference-client/cli-reference/nft-cli). --- -# dev +## dev {#dev} ## mempool @@ -426,21 +428,54 @@ chia dev mempool benchmark -n 1000 --- -## data (DataLayer) +## data (DataLayer) {#data-datalayer} The `chia data` command group is the CLI for the Chia DataLayer. For the full subcommand list and examples, see the [DataLayer CLI reference](/reference-client/cli-reference/datalayer-cli). --- -## solver +## solver {#solver} -The `chia solver` command group talks to the standalone Solver service (partial proofs → full proofs for V2 plots / PoS2-era farming). Run `chia solver -h`; current releases provide **`get_state`**. For connecting the farmer to a Solver over HTTP RPC, see [`connect_to_solver`](/reference-client/rpc-reference/farmer-rpc#connect_to_solver) on the Farmer RPC page. +The `chia solver` command group talks to the standalone Solver service (partial proofs → full proofs for V2 plots / PoS2-era farming). Run `chia solver -h`; current releases provide `get_state`. For connecting the farmer to a Solver over HTTP RPC, see `connect_to_solver` on the [Farmer RPC](/reference-client/rpc-reference/farmer-rpc) page. --- -## Other commands (not all are fully documented) - -The following sample output is aligned with the top-level Click groups registered in [`chia/cmds/chia.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/chia.py) (`version` and `run_daemon` are registered on the root CLI in the same file). **Your local `chia -h` may list commands in a different order.** The **`beta`** command exists in the client but is **hidden** from help unless your build exposes it. +## Top-level command index + +Every command below is registered on the root CLI in [`chia/cmds/chia.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/chia.py) (along with `version` and `run_daemon` in the same file). Run `chia -h` for subcommands and flags. Your local `chia -h` may list commands in a different order than this table. + +| Command | Summary | Documented on this site | +| :----------- | :----------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `completion` | Generate shell completion scripts | No dedicated page; run `chia completion -h`. | +| `configure` | Modify `config.yaml` (testnet, peers, ports, logging, and similar) | No dedicated section; run `chia configure -h`. Source: [`configure.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/configure.py). | +| `data` | DataLayer CLI | [DataLayer CLI](/reference-client/cli-reference/datalayer-cli) and [data (DataLayer)](#data-datalayer) above. | +| `db` | Blockchain database upgrade, backup, validate | [Database commands](#db). | +| `dev` | Developer tools (simulator, mempool tools, …) | [dev](#dev) (mempool); full simulator: [Simulator CLI](/reference-client/cli-reference/simulator-cli). | +| `farm` | Farm status and operations | No dedicated section; run `chia farm -h`. Example: `chia farm summary` (also mentioned under [Checking Logs and Status](#checking-logs-and-status)). | +| `init` | Create or migrate configuration | [init](#init). | +| `keys` | Key management and derivation | [keys](#keys). | +| `netspace` | Estimate total network space | No dedicated section; run `chia netspace -h`. | +| `passphrase` | Keyring passphrase | No dedicated section; run `chia passphrase -h`. | +| `peer` | List or change peer connections | No dedicated section; run `chia peer -h`. | +| `plotnft` | Plot NFT (pooling) | [plotnft](#plotnft). | +| `plots` | Plot directories and plot checks | [Plots check](#plots-check); other subcommands: run `chia plots -h`. | +| `plotters` | Launch bundled and third-party plotters | [plotters](#plotters). | +| `rpc` | Call JSON-RPC from the shell (“RPC client”) | HTTP RPC reference hub: [RPC introduction](/reference-client/rpc-reference/rpc); run `chia rpc -h` for CLI usage. | +| `run_daemon` | Run the Chia daemon process | Used when starting services; run `chia run_daemon -h`. | +| `show` | Show blockchain and node status | No dedicated section; run `chia show -h` (example: `chia show -s` below). | +| `solver` | Talk to the Solver service | [solver](#solver). | +| `start` | Start service groups | [start](#start). | +| `stop` | Stop service groups or daemon | No dedicated section; run `chia stop -h`. | +| `version` | Print the installed client version | Run `chia version`. | +| `wallet` | Wallet, offers, NFTs, DIDs, VCs, clawback, … | [Wallet CLI](/reference-client/cli-reference/wallet-cli) and linked topic pages in [Related CLI references](#related-cli-references). | + +Non-group commands on the same root CLI: + +| Command | Summary | Documented on this site | +| :------ | :------------------- | :------------------------------------------------------------------------------------------------------------ | +| `beta` | Beta-program helpers | Hidden from default `chia -h` in upstream (`chia/cmds/beta.py`). Run `chia beta -h` if your build exposes it. | + +The following sample output is aligned with a typical `chia` root help listing. The `beta` command is omitted there because it is hidden unless exposed by your build. ```sh $ chia @@ -480,7 +515,7 @@ Commands: ``` -To see what you can do with each of these commands, use the help flag -h. For example, `chia show -h`. +To see what you can do with each of these commands, use the help flag `-h`. For example, `chia show -h`. To check your full node status, do `chia show -s` and you'll see something like this. To figure how close you are look at your height. Once fully synced it'll say `Full Node Synced` at the top. @@ -505,7 +540,7 @@ Total iterations since the start of the blockchain: 63291534050 You can add and remove directories for your plots with `chia plots add -d 'your_dir'` or `chia plots remove -d 'your_dir'`, help can be found for respective add/remove with `chia plots add/remove -h` -## Checking Logs and Status +## Checking Logs and Status {#checking-logs-and-status} You can check contents of your wallet with: `chia wallet`, and status of your farmer with `chia farm summary`. From df85b4dde36986cb19e04303a3e9cfa24fda67a6 Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Thu, 7 May 2026 09:06:01 -0600 Subject: [PATCH 02/19] docs(cli): add full-node, farmer, harvester, and solver CLI reference pages Co-authored-by: Cursor --- .../cli-reference/farmer-cli.md | 75 +++++++++++++++++++ .../cli-reference/full-node-cli.md | 62 +++++++++++++++ .../cli-reference/harvester-cli.md | 52 +++++++++++++ .../cli-reference/solver-cli.md | 34 +++++++++ sidebars.js | 4 + 5 files changed, 227 insertions(+) create mode 100644 docs/reference-client/cli-reference/farmer-cli.md create mode 100644 docs/reference-client/cli-reference/full-node-cli.md create mode 100644 docs/reference-client/cli-reference/harvester-cli.md create mode 100644 docs/reference-client/cli-reference/solver-cli.md diff --git a/docs/reference-client/cli-reference/farmer-cli.md b/docs/reference-client/cli-reference/farmer-cli.md new file mode 100644 index 0000000000..caa303c061 --- /dev/null +++ b/docs/reference-client/cli-reference/farmer-cli.md @@ -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. | + +### `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: + +- 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) diff --git a/docs/reference-client/cli-reference/full-node-cli.md b/docs/reference-client/cli-reference/full-node-cli.md new file mode 100644 index 0000000000..c4a15f3940 --- /dev/null +++ b/docs/reference-client/cli-reference/full-node-cli.md @@ -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). + +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 ` 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) diff --git a/docs/reference-client/cli-reference/harvester-cli.md b/docs/reference-client/cli-reference/harvester-cli.md new file mode 100644 index 0000000000..59780bc9f9 --- /dev/null +++ b/docs/reference-client/cli-reference/harvester-cli.md @@ -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` + +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). +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` + +Shell JSON-RPC calls follow the same pattern as other services (see [RPC overview](/reference-client/rpc-reference/rpc)): + +```bash +chia rpc harvester '' +``` + +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) diff --git a/docs/reference-client/cli-reference/solver-cli.md b/docs/reference-client/cli-reference/solver-cli.md new file mode 100644 index 0000000000..4012f5bab4 --- /dev/null +++ b/docs/reference-client/cli-reference/solver-cli.md @@ -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 ''` like other services (see [RPC overview](/reference-client/rpc-reference/rpc)). + +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) diff --git a/sidebars.js b/sidebars.js index 2f5d6b7633..b945f89950 100644 --- a/sidebars.js +++ b/sidebars.js @@ -285,8 +285,12 @@ module.exports = { 'reference-client/cli-reference/offer-cli', 'reference-client/cli-reference/plotter-cli', 'reference-client/cli-reference/simulator-cli', + 'reference-client/cli-reference/solver-cli', 'reference-client/cli-reference/vc-cli', 'reference-client/cli-reference/wallet-cli', + 'reference-client/cli-reference/farmer-cli', + 'reference-client/cli-reference/full-node-cli', + 'reference-client/cli-reference/harvester-cli', 'reference-client/cli-reference/cat-admin-cli', 'reference-client/cli-reference/clawback-cli', 'reference-client/cli-reference/custody-tool-cli', From 50635bac812d124bde286ceef95c260a3ac3bcbf Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Thu, 7 May 2026 09:06:05 -0600 Subject: [PATCH 03/19] docs(cli): expand CLI overview hub, plots section, and command index Co-authored-by: Cursor --- docs/reference-client/cli-reference/cli.md | 167 ++++++++++++++------- 1 file changed, 111 insertions(+), 56 deletions(-) diff --git a/docs/reference-client/cli-reference/cli.md b/docs/reference-client/cli-reference/cli.md index 640c2b9251..b1627c62b0 100644 --- a/docs/reference-client/cli-reference/cli.md +++ b/docs/reference-client/cli-reference/cli.md @@ -9,13 +9,9 @@ import TabItem from '@theme/TabItem'; # CLI Commands Reference -This page should provide additional high-level documentation and explanation beyond just `chia -h`. +This **CLI overview** is the entry point for command-line usage, similar to the [RPC overview](/reference-client/rpc-reference/rpc) for JSON-RPC. It explains global options, where the `chia` binary lives, and links into **service CLI pages** that mirror the **RPC reference** layout ([Full Node CLI](/reference-client/cli-reference/full-node-cli), [Farmer CLI](/reference-client/cli-reference/farmer-cli), [Harvester CLI](/reference-client/cli-reference/harvester-cli), [Solver CLI](/reference-client/cli-reference/solver-cli), wallet and asset topics, and more). -This is not meant to be comprehensive, because often the `-h` (help) text is clear enough. We recommend fully investigating with the `-h` switch before looking elsewhere. - -To better understand what a command's options are, append `-h` at the end to see options and explanations. - -Some examples: +Always check `chia -h` and `chia -h` for the exact flags your build exposes. Examples: - `chia -h` - `chia plots -h` @@ -23,11 +19,28 @@ Some examples: - `chia plotters madmax -h` - `chia start -h` -As with the rest of this project, this doc is a work-in-progress. Feel free to browse the [source code](https://github.com/Chia-Network/chia-blockchain/tree/main/chia/cmds) or the [Chia Proof of Space Construction Document](https://www.chia.net/assets/Chia_Proof_of_Space_Construction_v1.1.pdf) for more insight in the meantime. +Browse [`chia/cmds`](https://github.com/Chia-Network/chia-blockchain/tree/main/chia/cmds) for implementation details. + +## Global options {#global-options} + +The root `chia` command accepts: -## Related CLI references {#related-cli-references} +| Option | Description | +| :--------------------------- | :---------------------------------------------------------------------------------------------------------------- | +| `--root-path PATH` | Configuration and data root (default: platform-specific mainnet directory under `.chia`). | +| `--keys-root-path PATH` | Keyring file root (default: `.chia_keys`). | +| `--passphrase-file FILENAME` | Read the keyring passphrase from a file or descriptor so non-interactive runs can unlock the keychain when valid. | -This page is an overview. Deeper command documentation lives in topic pages, for example: +## CLI reference map {#related-cli-references} + +**Chain and farming stack** (parallel to full node / farmer / harvester RPC pages): + +- [Full Node CLI](/reference-client/cli-reference/full-node-cli): `chia show`, `chia netspace`, `chia peer full_node` +- [Farmer CLI](/reference-client/cli-reference/farmer-cli): `chia farm`, `chia plotnft`, solver connection helpers +- [Harvester CLI](/reference-client/cli-reference/harvester-cli): `chia peer harvester`, plot directories, remote harvester notes +- [Solver CLI](/reference-client/cli-reference/solver-cli): `chia solver` + +**Wallet and assets:** - [Wallet CLI](/reference-client/cli-reference/wallet-cli) - [Offers](/reference-client/cli-reference/offer-cli) @@ -37,7 +50,11 @@ This page is an overview. Deeper command documentation lives in topic pages, for - [Plotters](/reference-client/cli-reference/plotter-cli) - [DID](/reference-client/cli-reference/did-cli) and [NFT](/reference-client/cli-reference/nft-cli) - [DAO CLI](/reference-client/cli-reference/dao-cli) (historical: the DAO wallet was [removed in Chia 2.5.3](https://github.com/Chia-Network/chia-blockchain/blob/main/CHANGELOG.md#253-chia-blockchain-2025-03-25)) -- HTTP RPC (for `chia rpc …`): [Wallet RPC](/reference-client/rpc-reference/wallet-rpc) and the other service pages under [RPC reference](/reference-client/rpc-reference/rpc) + +**Other:** + +- [DataLayer CLI](/reference-client/cli-reference/datalayer-cli) (`chia data`) +- HTTP JSON-RPC from the shell: [RPC overview](/reference-client/rpc-reference/rpc) and per-service pages such as [Wallet RPC](/reference-client/rpc-reference/wallet-rpc) # Locate the `chia` binary executable @@ -139,32 +156,31 @@ The cli reference for all plotters can be found in the [Plotters CLI Page](/refe ## plotnft {#plotnft} -Using the CLI, you can perform the same operations as with the GUI. There is a new command, called `chia plotnft`. Type `chia plotnft -h` to see all the available sub-commands: +`chia plotnft` manages plot NFTs and pool membership through the wallet RPC. Run `chia plotnft -h` for subcommands (`show`, `create`, `join`, `leave`, `claim`, `inspect`, `get_login_link`, and others). Full reference and examples: [Farmer CLI, Plot NFT](/reference-client/cli-reference/farmer-cli#plot-nft). -``` -» chia plotnft -h -Usage: chia plotnft [OPTIONS] COMMAND [ARGS]... +## plots {#plots} -Options: - -h, --help Show this message and exit. +Plot directory and validation commands. Source: [`chia/cmds/plots.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/plots.py). For MadMax, Bladebit, and other plotters, see [Plotters CLI](/reference-client/cli-reference/plotter-cli). -Commands: - claim Claim rewards from a plot NFT - create Create a plot NFT - get_login_link Create a login link for a pool. To get the launcher id, use - plotnft show. - - inspect Get Detailed plotnft information as JSON - join Join a plot NFT to a Pool - leave Leave a pool and return to self-farming - show Show plotnft information -``` +### `chia plots show` + +Lists directories configured for plot search (same paths the harvester uses). + +### `chia plots add` + +Usage: `chia plots add -d DIRECTORY` -To create a Plot NFT, use `chia plotnft create -u https://poolnamehere.com`, entering the URL of the pool you want to use. To create a plot NFT in self-farming mode, do `chia plotnft create -s local`. -To switch pools, you can use `chia plotnft join`, and to leave a pool (switch to self farming), use `chia plotnft leave`. -The `show` command can be used to check your current points balance. CLI plotting with `create_plots` is the same as before, but the `-p` is replaced with `-c`, and the pool contract address from `chia plotnft show` should be used here. +Adds a plot directory to `config.yaml` so farming software will scan it. -## [Plots check](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/plotting/check_plots.py) {#plots-check} +### `chia plots remove` + +Usage: `chia plots remove -d DIRECTORY` + +Removes a plot directory from the configured search list. + +### Plots check {#plots-check} + +Source: [`chia/plotting/check_plots.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/plotting/check_plots.py). Command: `chia plots check -n [num checks] -l -g [substring]` @@ -436,7 +452,46 @@ The `chia data` command group is the CLI for the Chia DataLayer. For the full su ## solver {#solver} -The `chia solver` command group talks to the standalone Solver service (partial proofs → full proofs for V2 plots / PoS2-era farming). Run `chia solver -h`; current releases provide `get_state`. For connecting the farmer to a Solver over HTTP RPC, see `connect_to_solver` on the [Farmer RPC](/reference-client/rpc-reference/farmer-rpc) page. +The `chia solver` command group queries the standalone Solver service. See [Solver CLI](/reference-client/cli-reference/solver-cli) for subcommands and farmer integration (`chia farm connect-solver`, [Farmer RPC](/reference-client/rpc-reference/farmer-rpc)). + +--- + +## configure {#configure} + +Usage: `chia configure [OPTIONS]` + +Writes updates to `config.yaml` under your Chia root. Restart running services after changes. Source: [`chia/cmds/configure.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/configure.py). + +| Option | Description | +| :--------------------------------------------- | :---------------------------------------------------------------- | +| `-t`, `--testnet` | `true`/`t` or `false`/`f` for testnet profile. | +| `--set-node-introducer` | Introducer `IP:Port` for the node. | +| `--set-farmer-peer` | Farmer address for a **remote harvester** (`IP:Port`). | +| `--set-solver-peer` | Solver `IP:Port` for the farmer. | +| `--set-solver-trusted-peers-only` | `true`/`false` for solver trusted-peer mode. | +| `--set-fullnode-port` | Full node port (updates related peer defaults). | +| `--set-harvester-port` | Harvester port. | +| `--set-log-level`, `--log-level`, `-log-level` | One of `CRITICAL`, `ERROR`, `WARNING`, `INFO`, `DEBUG`, `NOTSET`. | +| `--enable-upnp`, `--upnp`, `-upnp` | Enable or disable UPnP (`true`/`false`). | +| `--set_outbound-peer-count` | Target outbound peer count. | +| `--set-peer-count` | Target peer count. | +| `--set-peer-connect-timeout` | Peer connect timeout (seconds). | +| `--crawler-db-path` | Crawler database path. | +| `--crawler-minimum-version-count` | Crawler minimum version reporting threshold. | +| `--seeder-domain-name` | Seeder DNS domain. | +| `--seeder-nameserver` | Seeder nameserver. | + +## passphrase {#passphrase} + +Usage: `chia passphrase COMMAND` + +Manage the keyring passphrase (`set`, `remove`, and related subcommands). Source: [`chia/cmds/passphrase.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/passphrase.py). Run `chia passphrase -h`. Optional files `--passphrase-file` and `--current-passphrase-file` avoid interactive prompts. + +## stop {#stop} + +Usage: `chia stop [OPTIONS] GROUP [GROUP ...]` + +Stops service groups via the daemon. Use `-d` / `--daemon` to stop the daemon itself. `GROUP` values match the same service groups as **`chia start`** (see the **start** section on this page). Source: [`chia/cmds/stop.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/stop.py). --- @@ -444,30 +499,30 @@ The `chia solver` command group talks to the standalone Solver service (partial Every command below is registered on the root CLI in [`chia/cmds/chia.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/chia.py) (along with `version` and `run_daemon` in the same file). Run `chia -h` for subcommands and flags. Your local `chia -h` may list commands in a different order than this table. -| Command | Summary | Documented on this site | -| :----------- | :----------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `completion` | Generate shell completion scripts | No dedicated page; run `chia completion -h`. | -| `configure` | Modify `config.yaml` (testnet, peers, ports, logging, and similar) | No dedicated section; run `chia configure -h`. Source: [`configure.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/configure.py). | -| `data` | DataLayer CLI | [DataLayer CLI](/reference-client/cli-reference/datalayer-cli) and [data (DataLayer)](#data-datalayer) above. | -| `db` | Blockchain database upgrade, backup, validate | [Database commands](#db). | -| `dev` | Developer tools (simulator, mempool tools, …) | [dev](#dev) (mempool); full simulator: [Simulator CLI](/reference-client/cli-reference/simulator-cli). | -| `farm` | Farm status and operations | No dedicated section; run `chia farm -h`. Example: `chia farm summary` (also mentioned under [Checking Logs and Status](#checking-logs-and-status)). | -| `init` | Create or migrate configuration | [init](#init). | -| `keys` | Key management and derivation | [keys](#keys). | -| `netspace` | Estimate total network space | No dedicated section; run `chia netspace -h`. | -| `passphrase` | Keyring passphrase | No dedicated section; run `chia passphrase -h`. | -| `peer` | List or change peer connections | No dedicated section; run `chia peer -h`. | -| `plotnft` | Plot NFT (pooling) | [plotnft](#plotnft). | -| `plots` | Plot directories and plot checks | [Plots check](#plots-check); other subcommands: run `chia plots -h`. | -| `plotters` | Launch bundled and third-party plotters | [plotters](#plotters). | -| `rpc` | Call JSON-RPC from the shell (“RPC client”) | HTTP RPC reference hub: [RPC introduction](/reference-client/rpc-reference/rpc); run `chia rpc -h` for CLI usage. | -| `run_daemon` | Run the Chia daemon process | Used when starting services; run `chia run_daemon -h`. | -| `show` | Show blockchain and node status | No dedicated section; run `chia show -h` (example: `chia show -s` below). | -| `solver` | Talk to the Solver service | [solver](#solver). | -| `start` | Start service groups | [start](#start). | -| `stop` | Stop service groups or daemon | No dedicated section; run `chia stop -h`. | -| `version` | Print the installed client version | Run `chia version`. | -| `wallet` | Wallet, offers, NFTs, DIDs, VCs, clawback, … | [Wallet CLI](/reference-client/cli-reference/wallet-cli) and linked topic pages in [Related CLI references](#related-cli-references). | +| Command | Summary | Documented on this site | +| :----------- | :----------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `completion` | Generate shell completion scripts | Run `chia completion -h`. | +| `configure` | Modify `config.yaml` (testnet, peers, ports, logging, and similar) | [configure](#configure). | +| `data` | DataLayer CLI | [DataLayer CLI](/reference-client/cli-reference/datalayer-cli) and [data (DataLayer)](#data-datalayer) above. | +| `db` | Blockchain database upgrade, backup, validate | [Database commands](#db). | +| `dev` | Developer tools (simulator, mempool tools, …) | [dev](#dev) (mempool); full simulator: [Simulator CLI](/reference-client/cli-reference/simulator-cli). | +| `farm` | Farm status and operations | [Farmer CLI](/reference-client/cli-reference/farmer-cli); example: `chia farm summary` under [Checking Logs and Status](#checking-logs-and-status). | +| `init` | Create or migrate configuration | [init](#init). | +| `keys` | Key management and derivation | [keys](#keys). | +| `netspace` | Estimate total network space | [Full Node CLI](/reference-client/cli-reference/full-node-cli) (`chia netspace`). | +| `passphrase` | Keyring passphrase | [passphrase](#passphrase). | +| `peer` | List or change peer connections | [Full Node CLI](/reference-client/cli-reference/full-node-cli) (`peer full_node`), [Farmer CLI](/reference-client/cli-reference/farmer-cli), [Harvester CLI](/reference-client/cli-reference/harvester-cli); run `chia peer -h` for all node types. | +| `plotnft` | Plot NFT (pooling) | [plotnft](#plotnft) and [Farmer CLI](/reference-client/cli-reference/farmer-cli#plot-nft). | +| `plots` | Plot directories and plot checks | [plots](#plots). | +| `plotters` | Launch bundled and third-party plotters | [plotters](#plotters). | +| `rpc` | Call JSON-RPC from the shell (“RPC client”) | [RPC introduction](/reference-client/rpc-reference/rpc); run `chia rpc -h` for CLI usage. | +| `run_daemon` | Run the Chia daemon process | Used when starting services; run `chia run_daemon -h`. | +| `show` | Show blockchain and node status | [Full Node CLI](/reference-client/cli-reference/full-node-cli); example: `chia show -s` below. | +| `solver` | Talk to the Solver service | [solver](#solver), [Solver CLI](/reference-client/cli-reference/solver-cli). | +| `start` | Start service groups | [start](#start). | +| `stop` | Stop service groups or daemon | [stop](#stop). | +| `version` | Print the installed client version | Run `chia version`. | +| `wallet` | Wallet, offers, NFTs, DIDs, VCs, clawback, … | [Wallet CLI](/reference-client/cli-reference/wallet-cli) and [CLI reference map](#related-cli-references). | Non-group commands on the same root CLI: From 26016693fee1c74b5326050383e742d2ee7b1367 Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Fri, 8 May 2026 09:18:26 -0600 Subject: [PATCH 04/19] docs(cli): address PR 990 review (examples, plots-cli, prose, anchors) Co-authored-by: Cursor --- docs/reference-client/cli-reference/cli.md | 177 +++++++++--------- .../cli-reference/farmer-cli.md | 75 ++++++-- .../cli-reference/full-node-cli.md | 37 +++- .../cli-reference/harvester-cli.md | 34 ++-- .../cli-reference/plots-cli.md | 135 +++++++++++++ .../cli-reference/solver-cli.md | 18 +- .../rpc-reference/solver-rpc.md | 2 +- .../check-if-things-are-working.md | 2 +- sidebars.js | 1 + 9 files changed, 351 insertions(+), 130 deletions(-) create mode 100644 docs/reference-client/cli-reference/plots-cli.md diff --git a/docs/reference-client/cli-reference/cli.md b/docs/reference-client/cli-reference/cli.md index b1627c62b0..c09a8cefde 100644 --- a/docs/reference-client/cli-reference/cli.md +++ b/docs/reference-client/cli-reference/cli.md @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem'; # CLI Commands Reference -This **CLI overview** is the entry point for command-line usage, similar to the [RPC overview](/reference-client/rpc-reference/rpc) for JSON-RPC. It explains global options, where the `chia` binary lives, and links into **service CLI pages** that mirror the **RPC reference** layout ([Full Node CLI](/reference-client/cli-reference/full-node-cli), [Farmer CLI](/reference-client/cli-reference/farmer-cli), [Harvester CLI](/reference-client/cli-reference/harvester-cli), [Solver CLI](/reference-client/cli-reference/solver-cli), wallet and asset topics, and more). +This **CLI overview** is the entry point for command-line usage, similar to the [RPC overview](/reference-client/rpc-reference/rpc) for JSON-RPC. It documents global options, where the `chia` binary lives, and links into service CLI pages listed in the [CLI reference map](#related-cli-references). Always check `chia -h` and `chia -h` for the exact flags your build exposes. Examples: @@ -21,7 +21,7 @@ Always check `chia -h` and `chia -h` for the exact flags your build ex Browse [`chia/cmds`](https://github.com/Chia-Network/chia-blockchain/tree/main/chia/cmds) for implementation details. -## Global options {#global-options} +## Global CLI options {#global-cli-options} The root `chia` command accepts: @@ -48,6 +48,7 @@ The root `chia` command accepts: - [Clawback](/reference-client/cli-reference/clawback-cli) - [Simulator](/reference-client/cli-reference/simulator-cli) - [Plotters](/reference-client/cli-reference/plotter-cli) +- [Plots CLI](/reference-client/cli-reference/plots-cli) - [DID](/reference-client/cli-reference/did-cli) and [NFT](/reference-client/cli-reference/nft-cli) - [DAO CLI](/reference-client/cli-reference/dao-cli) (historical: the DAO wallet was [removed in Chia 2.5.3](https://github.com/Chia-Network/chia-blockchain/blob/main/CHANGELOG.md#253-chia-blockchain-2025-03-25)) @@ -156,130 +157,136 @@ The cli reference for all plotters can be found in the [Plotters CLI Page](/refe ## plotnft {#plotnft} -`chia plotnft` manages plot NFTs and pool membership through the wallet RPC. Run `chia plotnft -h` for subcommands (`show`, `create`, `join`, `leave`, `claim`, `inspect`, `get_login_link`, and others). Full reference and examples: [Farmer CLI, Plot NFT](/reference-client/cli-reference/farmer-cli#plot-nft). +`chia plotnft` manages plot NFTs and pool membership through the wallet RPC. Command tables, pooling flows, and more examples are on [Farmer CLI, Plot NFT](/reference-client/cli-reference/farmer-cli#plot-nft). -## plots {#plots} - -Plot directory and validation commands. Source: [`chia/cmds/plots.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/plots.py). For MadMax, Bladebit, and other plotters, see [Plotters CLI](/reference-client/cli-reference/plotter-cli). - -### `chia plots show` - -Lists directories configured for plot search (same paths the harvester uses). - -### `chia plots add` - -Usage: `chia plots add -d DIRECTORY` +Subcommands from `chia plotnft -h`: -Adds a plot directory to `config.yaml` so farming software will scan it. +```text +Usage: chia plotnft [OPTIONS] COMMAND [ARGS]... -### `chia plots remove` - -Usage: `chia plots remove -d DIRECTORY` +Options: + -h, --help Show this message and exit. -Removes a plot directory from the configured search list. +Commands: + claim Claim rewards from a plot NFT + create Create a plot NFT + get_login_link Create a login link for a pool. To get the launcher id, use plotnft show. + inspect Get Detailed plotnft information as JSON + join Join a plot NFT to a Pool + leave Leave a pool and return to self-farming + show Show plotnft information +``` -### Plots check {#plots-check} +
+Example -Source: [`chia/plotting/check_plots.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/plotting/check_plots.py). +```bash +chia plotnft show +chia plotnft create -u https://pool.example.com +chia plotnft create -s local +``` -Command: `chia plots check -n [num checks] -l -g [substring]` +
-First, this looks in all plot directories from your config.yaml. You can check those directories with `chia plots show`. This command will check whether plots are valid given the plot's associated keys and your machine's stored Chia keys, as well as test the plot with challenges to identify found plots vs. expected number of plots. +## plots {#plots} -`-g` check only plots with directory or file name containing case-sensitive [substring]. -**If `-g` isn't specified all plots in every plot directory in your config.yaml will be checked.** +The `chia plots` command group lists configured directories, adds or removes plot search paths, can run legacy `create`, and validates plots with `check`. Full option tables and `plots check` guidance are on [Plots CLI](/reference-client/cli-reference/plots-cli) (including [Plots check](/reference-client/cli-reference/plots-cli#plots-check)). For Bladebit, MadMax, and other external plotters, see [Plotters CLI](/reference-client/cli-reference/plotter-cli). -Examples for using `-g` +## db {#db} -- Check plots within a long directory name like `/mnt/chia/DriveA` can use `chia plots check -g DriveA` -- Check only k33 plots can use `chia plots check -g k33` -- Check plots created on October 31, 2020 can use `chia plots check -g 2020-10-31` +The `chia db` commands upgrade the blockchain database format, create a vacuumed backup, or validate an existing file. Paths usually follow `full_node.database_path` in `config.yaml` under your Chia root. Source module: [`chia/cmds/db.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/db.py). -`-l` allows you to find duplicate plots by ID. It checks all plot directories listed in config.yaml and lists out any plot filenames with the same filename ending; `*-[64 char plot ID].plot`. You should use `-l -n 0` if you only want to check for duplicates. +### upgrade {#upgrade} -`-n` represents the number of challenges given. If you don't include an `-n` integer, the default is 30. For instance, if `-n` is 30, then 30 challenges will be given to each plot. The challenges count from 5 (minimum) to `-n`, and are not random. +Implementation: [`db_upgrade_cmd`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/db.py) -Each plot will take each challenge and: +Command: `chia db upgrade [OPTIONS]` -- Get the quality for the challenge (Is there a proof of space? You should expect 1 proof per challenge, but there may be 0 or more than 1.) -- Get the full proof(s) for the challenge if a proof was present -- Validate that the # of full proofs matches the # of expected quality proofs. +**Flags** -Finally, you'll see a report the final true proofs vs. expected proofs. +`--input [PATH]`: Optional v1 database input file. -Therefore, if `-n` is 20, you would expect 20 proofs, but your plot may have more or fewer. +`--output [PATH]`: Optional v2 output path (must not exist unless workflow allows). -Running the command with `-n 10` or `-n 20` is good for a very minor check, but won't actually give you much information about if the plots are actually high-quality or not. +`--no-update-config`: Do not rewrite `config.yaml` to point at the new database (also applies when using a custom output path in typical setups). -Consider using `-n 30` to get a statistically better idea. +`--force`: Proceed despite warnings when the upgrade tool would otherwise stop. -For more detail, you can read about the DiskProver commands in [chiapos](https://github.com/Chia-Network/chiapos/blob/main/src/prover_disk.hpp) +**Database upgrade notes** -**What does the ratio of full proofs vs expected proofs mean?** +- This will upgrade your database from version 1 to version 2, which is around 45% smaller and slightly faster. +- The upgrade could take several hours to complete. Use at your own leisure. +- You do not need to stop your Chia node while performing the upgrade. +- The new database file will be written to the same folder as the original. The current size requirement (2nd quarter 2022) is around 55 GB. _Note that the database is always growing, so the size requirement for the v2 database will have gone up by the time you are reading this, so plan free disk space accordingly._ After the version 2 file has been created, you can stop Chia and move/delete your version 1 file, which will free up enough space to move your version 2 file to the original folder. Finally, update the references in config.yaml to point to your version 2 file. +- After the upgrade has completed, run `chia start farmer -r`. This will restart your farmer, and begin using your new database. Note that it will have the same peak as version 1 at the time you _initiated_ the upgrade. Your node will still need to run a short sync to fetch the remaining blocks that had gotten added while the upgrade was being performed. +- For more information on the new database version, see our [FAQ](https://docs.chia.net/chia-blockchain/resources/faq/#what-is-the-new-database). -- If the ratio is >1, your plot was relatively lucky for this run of challenges. -- If the ratio is \<1, your plot was relatively unlucky. - - This shouldn't really concern you unless your ratio is \<0.70 # If so, do a more thorough `chia plots check` by increasing your `-n` +
+Example -The plots check challenge is a static challenge. For example if you run a plots check 20 times, with 30 tries against the same file, it will produce the same result every time. So while you may see a plot ratio \<< 1 for a plot check with `x` number of tries, it does not mean that the plot itself is worthless. It just means that given these static challenges, the plot is producing however many proofs. As the number of tries (`-n`) increases, we would expect the ratio to not be \<< 1. Since Mainnet is live, and given that the blockchain has new challenges with every signage point - just because a plot is having a bad time with one specific challenge, does not mean it has the same results versus another challenge. "Number of plots" and "k-size" are much more influential factors at winning blocks than "proofs produced per challenge". +```bash +chia db upgrade +chia db upgrade --input ~/.chia/mainnet/db/blockchain_v1_mainnet.sqlite --output ~/.chia/mainnet/db/blockchain_v2_mainnet.sqlite +``` -**In theory**, a plot with a ratio >> 1 would be more likely to win challenges on the blockchain. Likewise, a plot with a ratio \<< 1 would be less likely to win. However, in practice, this isn't actually going to be noticeable. Therefore, don't worry if your plot check ratios are less than 1, unless they're _significantly_ less than 1 for _many_ `-n`. +
-## db {#db} +### backup {#backup} -## [upgrade](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/db.py) +Implementation: [`db_backup_cmd`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/db.py) -Command: `chia db upgrade [add flags and parameters]` +Command: `chia db backup [OPTIONS]` **Flags** -`--input [PATH]`: (optional) Specify a database input file. Must be a v1 database. +`--backup_file [PATH]`: Optional backup path. Default writes next to the active database. -`--output [PATH]`: (optional) Specify a database output file. Can be any name, but must not already exist. +`--no_indexes`: Write the backup without indexes. -`--no-update-config` Don't update the config file to point to your new database. When specifying a custom output file, the config will not be updated regardless. +**Database backup notes** -**Database upgrade notes** +- This will vacuum (compress) and backup your database and may take several hours to complete. Use at your own leisure. +- You do not need to stop your Chia node during backup. +- The new database file will be written to the same folder as the original with `vacuumed_` prepended to the name unless you pass `--backup_file`. +- To use the backup database: close the Chia client, remove or rename the main database, rename the backup to replace it, and restart the client. The first start may take longer while the client verifies the file. -- This will upgrade your database from version 1 to version 2, which is around 45% smaller and slightly faster. -- The upgrade could take several hours to complete. Use at your own leisure. -- You do not need to stop your Chia node while performing the upgrade. -- The new database file will be written to the same folder as the original. The current size requirement (2nd quarter 2022) is around 55 GB. _Note that the database is always growing, so the size requirement for the v2 database will have gone up by the time you are reading this — plan accordingly_. After the version 2 file has been created, you can stop Chia and move/delete your version 1 file, which will free up enough space to move your version 2 file to the original folder. Finally, update the references in config.yaml to point to your version 2 file. -- After the upgrade has completed, run `chia start farmer -r`. This will restart your farmer, and begin using your new database. Note that it will have the same peak as version 1 at the time you _initiated_ the upgrade. Your node will still need to run a short sync to fetch the remaining blocks that had gotten added while the upgrade was being performed. -- For more information on the new database version, see our [FAQ](https://docs.chia.net/chia-blockchain/resources/faq/#what-is-the-new-database). +
+Example -## [backup](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/db.py) +```bash +chia db backup +chia db backup --backup_file ~/chia-db-backup.sqlite +``` -Command: `chia db backup [add flags and parameters]` +
-**Flags** +### validate {#validate} -`--backup_file [PATH]`: (optional) Specifies the backup file and location. Default will create the backup in the same directory as the database. +Implementation: [`db_validate_cmd`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/db.py) -`--no_indexes`: (optional) Create backup without indexes. +Command: `chia db validate [OPTIONS]` -**Database backup notes** - -- This will vacuum (compress) and backup your database and may take several hours to complete. Use at your own leisure. -- You do not need to stop your Chia node while performing the upgrade. -- The new database file will be written to the same folder as the original with "vacuumed\_" prepended to the name. -- To use the backup database: Close the chia client, remove/delete the main database, rename the backup database to remove "vacuumed\_", and restart the chia client. Note the initial start will take extra time as the client verifies the backup db file. +**Flags** -## [validate](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/db.py) +`--db [PATH]`: Database file to validate (defaults to the configured blockchain database). -Command: `chia db validate [add flags and parameters]` +`--validate-blocks`: Also validate encoded blocks and block records (slower). -**Flags** +**Database validate notes** -`--db [PATH]`: (optional) Specifies which database file to validate. Default will use the default database and path. +- Validation may take several hours on a full chain database. +- You do not need to stop your Chia node while validating. +- Processing starts from the tip and walks toward genesis. -`--validate-blocks`: (optional) Validate consistency of properties of the encoded blocks and block records. Note this will increase the validation time. +
+Example -**Database validate notes** +```bash +chia db validate +chia db validate --validate-blocks +``` -- This will validate your database and may take several hours to complete. Use at your own leisure. -- You do not need to stop your Chia node while performing the upgrade. -- This will start by processing the latest block and traverse to the first block. +
## keys {#keys} @@ -388,9 +395,11 @@ See our [official NFT reference](/reference-client/cli-reference/nft-cli). ## dev {#dev} -## mempool +Developer-focused commands (experimental or diagnostic). Mempool helpers below target Chia 2.5.5 and later. For the simulator service, see [Simulator CLI](/reference-client/cli-reference/simulator-cli). + +### mempool -The `chia dev mempool` commands provide developer tools for managing and analyzing the mempool. These commands are available in Chia 2.5.5 and later versions. +The `chia dev mempool` commands manage or inspect mempool data for development and testing. ### import @@ -452,7 +461,7 @@ The `chia data` command group is the CLI for the Chia DataLayer. For the full su ## solver {#solver} -The `chia solver` command group queries the standalone Solver service. See [Solver CLI](/reference-client/cli-reference/solver-cli) for subcommands and farmer integration (`chia farm connect-solver`, [Farmer RPC](/reference-client/rpc-reference/farmer-rpc)). +The `chia solver` command group queries the standalone Solver service. See [Solver CLI](/reference-client/cli-reference/solver-cli). To attach the farmer to a solver peer via RPC, see `connect_to_solver` on [Farmer RPC](/reference-client/rpc-reference/farmer-rpc). CLI helper: [`chia farm connect-solver`](/reference-client/cli-reference/farmer-cli#chia-farm-connect-solver). --- @@ -466,7 +475,7 @@ Writes updates to `config.yaml` under your Chia root. Restart running services a | :--------------------------------------------- | :---------------------------------------------------------------- | | `-t`, `--testnet` | `true`/`t` or `false`/`f` for testnet profile. | | `--set-node-introducer` | Introducer `IP:Port` for the node. | -| `--set-farmer-peer` | Farmer address for a **remote harvester** (`IP:Port`). | +| `--set-farmer-peer` | Farmer address for a remote harvester (`IP:Port`). | | `--set-solver-peer` | Solver `IP:Port` for the farmer. | | `--set-solver-trusted-peers-only` | `true`/`false` for solver trusted-peer mode. | | `--set-fullnode-port` | Full node port (updates related peer defaults). | @@ -513,7 +522,7 @@ Every command below is registered on the root CLI in [`chia/cmds/chia.py`](https | `passphrase` | Keyring passphrase | [passphrase](#passphrase). | | `peer` | List or change peer connections | [Full Node CLI](/reference-client/cli-reference/full-node-cli) (`peer full_node`), [Farmer CLI](/reference-client/cli-reference/farmer-cli), [Harvester CLI](/reference-client/cli-reference/harvester-cli); run `chia peer -h` for all node types. | | `plotnft` | Plot NFT (pooling) | [plotnft](#plotnft) and [Farmer CLI](/reference-client/cli-reference/farmer-cli#plot-nft). | -| `plots` | Plot directories and plot checks | [plots](#plots). | +| `plots` | Plot directories and plot checks | [plots](#plots), [Plots CLI](/reference-client/cli-reference/plots-cli). | | `plotters` | Launch bundled and third-party plotters | [plotters](#plotters). | | `rpc` | Call JSON-RPC from the shell (“RPC client”) | [RPC introduction](/reference-client/rpc-reference/rpc); run `chia rpc -h` for CLI usage. | | `run_daemon` | Run the Chia daemon process | Used when starting services; run `chia run_daemon -h`. | diff --git a/docs/reference-client/cli-reference/farmer-cli.md b/docs/reference-client/cli-reference/farmer-cli.md index caa303c061..322fa9ef9e 100644 --- a/docs/reference-client/cli-reference/farmer-cli.md +++ b/docs/reference-client/cli-reference/farmer-cli.md @@ -4,7 +4,7 @@ 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). +Commands that query farming and pooling state through the farmer and wallet RPC clients. Default farmer RPC port is 8559 (`farmer.rpc_port`). JSON-RPC methods are documented on [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). @@ -14,7 +14,7 @@ Sources: [`chia/cmds/farm.py`](https://github.com/Chia-Network/chia-blockchain/b Usage: `chia farm summary [OPTIONS]` -Prints farming status: blockchain sync (via full node), harvester summaries, plot counts, and estimated rewards when services are reachable. +Prints farming status: blockchain sync via full node, harvester summaries, plot counts, and estimated rewards when services are reachable. | Option | Description | | :----------------------------- | :------------------------------------------------ | @@ -24,6 +24,16 @@ Prints farming status: blockchain sync (via full node), harvester summaries, plo | `-fp`, `--farmer-rpc-port` | Farmer RPC port. | | `-i`, `--include-pool-rewards` | Include pool farming rewards in displayed totals. | +
+Example + +```bash +chia farm summary +chia farm summary -fp 8559 -p 8555 +``` + +
+ ### `chia farm challenges` Usage: `chia farm challenges [OPTIONS]` @@ -35,36 +45,69 @@ Shows recent signage point challenges from the farmer. | `-fp`, `--farmer-rpc-port` | Farmer RPC port. | | `-l`, `--limit` | Max challenges to print (`0` disables the limit). | +
+Example + +```bash +chia farm challenges -l 10 +``` + +
+ ### `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). +Points the farmer at a Solver service (`host:port`). The same integration is available over farmer RPC as `connect_to_solver` on [Farmer RPC](/reference-client/rpc-reference/farmer-rpc). See also [Solver CLI](/reference-client/cli-reference/solver-cli). | Option | Description | | :------------------------- | :--------------- | | `-fp`, `--farmer-rpc-port` | Farmer RPC port. | +
+Example + +```bash +chia farm connect-solver 192.0.2.10:8666 +``` + +
+ ## 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: +Plot NFT commands call the wallet RPC for pooling operations. + +| Command | Purpose | +| :--------------- | :------------------------------------------------------- | +| `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` | Plot NFT details as JSON. | +| `get_login_link` | Pool login link (needs launcher id from `plotnft show`). | + +
+Example: `plotnft show` + +```bash +chia plotnft show +``` + +
+ +
+Example: create pool and self-farming plot NFTs -| 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`). | +```bash +chia plotnft create -u https://pool.example.com +chia plotnft create -s local +``` -Examples: +
-- 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). +When plotting pool plots, pass the pool contract address from `chia plotnft show` to your plotting command (`-c`), not the legacy pool public key option. ## Related diff --git a/docs/reference-client/cli-reference/full-node-cli.md b/docs/reference-client/cli-reference/full-node-cli.md index c4a15f3940..f46304d50d 100644 --- a/docs/reference-client/cli-reference/full-node-cli.md +++ b/docs/reference-client/cli-reference/full-node-cli.md @@ -4,7 +4,7 @@ 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). +Commands that talk to the full node use its RPC interface (default port 8555, `full_node.rpc_port` in `config.yaml`). HTTP JSON-RPC methods are listed on [Full Node RPC](/reference-client/rpc-reference/full-node-rpc). 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). @@ -22,9 +22,19 @@ Shows blockchain and fee information via the full node. At least one option is r | `-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`). | +
+Example + +```bash +chia show -s +chia show --fee +``` + +
+ :::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. +`-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. ::: @@ -40,18 +50,37 @@ Estimates total network space from full node chain data. | `-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). | +
+Example + +```bash +chia netspace -d 192 +``` + +
+ ## `chia peer full_node` Usage: `chia peer full_node [OPTIONS]` -Inspect or change **full node** peer connections (same RPC service as `chia show`). +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. | +| `-r`, `--remove-connection` | Remove a peer by the first 8 characters of its node id. | + +
+Example + +```bash +chia peer full_node -c +chia peer full_node -a 203.0.113.5:8444 +``` + +
Other `chia peer ` 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. diff --git a/docs/reference-client/cli-reference/harvester-cli.md b/docs/reference-client/cli-reference/harvester-cli.md index 59780bc9f9..db475fa8fd 100644 --- a/docs/reference-client/cli-reference/harvester-cli.md +++ b/docs/reference-client/cli-reference/harvester-cli.md @@ -4,11 +4,11 @@ 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`. +There is no top-level `chia harvester` group. Start the harvester with `chia start harvester` (see the `start` section on the [CLI overview](/reference-client/cli-reference/cli)) or via groups such as `farmer`. CLI operations below use the harvester RPC (default port 8560, `harvester.rpc_port`) or plot paths from `config.yaml`. -For HTTP JSON-RPC methods, see [Harvester RPC](/reference-client/rpc-reference/harvester-rpc). +HTTP JSON-RPC methods and payloads are documented on [Harvester RPC](/reference-client/rpc-reference/harvester-rpc). Use `chia rpc harvester ''` the same way as other services (see [RPC overview](/reference-client/rpc-reference/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). +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 peer harvester` @@ -21,32 +21,26 @@ Usage: `chia peer harvester [OPTIONS]` | `-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) +
+Example -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). -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)). +```bash +chia peer harvester -c +``` -After certificate and peer configuration changes, restart affected services. +
-## `chia rpc harvester` +## Plot directories -Shell JSON-RPC calls follow the same pattern as other services (see [RPC overview](/reference-client/rpc-reference/rpc)): +The harvester reads plot search paths from configuration. Manage directories with `chia plots` on [Plots CLI](/reference-client/cli-reference/plots-cli) (`show`, `add`, `remove`, `check`). -```bash -chia rpc harvester '' -``` +## Remote harvester -Method names and payloads match [Harvester RPC](/reference-client/rpc-reference/harvester-rpc). +For TLS, copying CA material, and multi-machine layout, follow [Farming on many machines](/reference-client/farming/farming-many-machines). On the harvester host, point the client at your farmer with `chia configure --set-farmer-peer IP:Port` (see the configure section on the [CLI overview](/reference-client/cli-reference/cli)), then restart services. ## Related - [CLI overview](/reference-client/cli-reference/cli) +- [Plots CLI](/reference-client/cli-reference/plots-cli) - [Farmer CLI](/reference-client/cli-reference/farmer-cli) - [Harvester RPC](/reference-client/rpc-reference/harvester-rpc) diff --git a/docs/reference-client/cli-reference/plots-cli.md b/docs/reference-client/cli-reference/plots-cli.md new file mode 100644 index 0000000000..066e753bf0 --- /dev/null +++ b/docs/reference-client/cli-reference/plots-cli.md @@ -0,0 +1,135 @@ +--- +sidebar_label: Plots +title: Plots CLI +slug: /reference-client/cli-reference/plots-cli +--- + +This document describes the `chia plots` command group for listing plot directories, adding and removing search paths, legacy `create`, and `check` validation. For Bladebit, MadMax, and other external plotters, see [Plotters CLI](/reference-client/cli-reference/plotter-cli). + +Sources: [`chia/cmds/plots.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/plots.py), [`chia/plotting/check_plots.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/plotting/check_plots.py). + +## `chia plots show` + +Functionality: Print configured plot search directories from `config.yaml` (same paths the harvester uses). + +Usage: `chia plots show` + +
+Example + +```bash +chia plots show +``` + +
+ +## `chia plots add` + +Functionality: Register a directory so the harvester searches it for plots. + +Usage: `chia plots add [OPTIONS]` + +| Option | Type | Required | Description | +| :------------------ | :--- | :------- | :----------------------------------- | +| `-d`, `--final_dir` | PATH | False | Plot directory to add (default `.`). | + +
+Example + +```bash +chia plots add -d /mnt/chia/plots +``` + +
+ +## `chia plots remove` + +Functionality: Remove a directory from the configured plot search list. + +Usage: `chia plots remove [OPTIONS]` + +| Option | Type | Required | Description | +| :------------------ | :--- | :------- | :-------------------------------------- | +| `-d`, `--final_dir` | PATH | False | Plot directory to remove (default `.`). | + +
+Example + +```bash +chia plots remove -d /mnt/old-plots +``` + +
+ +## `chia plots create` + +Functionality: Legacy in-process plotting (Chiapos-style). Most users prefer [Plotters CLI](/reference-client/cli-reference/plotter-cli) instead. + +Usage: `chia plots create [OPTIONS]` + +| Option | Type | Required | Description | +| :------------------------------ | :------ | :------- | :------------------------------------------- | +| `-k`, `--size` | INTEGER | False | Plot k-size (default 32). | +| `--override-k` | flag | False | Allow k-size smaller than 32. | +| `-n`, `--num` | INTEGER | False | Number of plots or challenges (default 1). | +| `-b`, `--buffer` | INTEGER | False | Sort buffer megabytes (default 3389). | +| `-r`, `--num_threads` | INTEGER | False | Thread count (default 2). | +| `-u`, `--buckets` | INTEGER | False | Bucket count (default 128). | +| `-a`, `--alt_fingerprint` | INTEGER | False | Alternative key fingerprint. | +| `-c`, `--pool_contract_address` | TEXT | False | Pool contract address for pool plots. | +| `-f`, `--farmer_public_key` | TEXT | False | Farmer public key hex. | +| `-p`, `--pool_public_key` | TEXT | False | Pool public key hex. | +| `-t`, `--tmp_dir` | PATH | False | Temp directory (default `.`). | +| `-2`, `--tmp2_dir` | PATH | False | Second temp directory. | +| `-d`, `--final_dir` | PATH | False | Final plot directory (default `.`). | +| `-i`, `--plotid` | TEXT | False | Plot ID hex (reproduce plot). | +| `-m`, `--memo` | TEXT | False | Memo hex (reproduce plot). | +| `-e`, `--nobitfield` | flag | False | Disable bitfield. | +| `-x`, `--exclude_final_dir` | flag | False | Do not add final dir to harvester plot list. | + +
+Example + +```bash +chia plots create -k 32 -n 1 -t /tmp/chia -d /plots/final +``` + +
+ +## Plots check {#plots-check} + +Functionality: Validate plots against keys and run repeated challenges to compare observed vs expected proofs. + +Usage: `chia plots check [OPTIONS]` + +| Option | Type | Required | Description | +| :------------------------ | :------ | :------- | :---------------------------------------------------- | +| `-n`, `--num` | INTEGER | False | Number of challenges per plot (default 30). | +| `-g`, `--grep_string` | TEXT | False | Only check paths/filenames containing this substring. | +| `-l`, `--list_duplicates` | flag | False | List plots that share the same plot ID. | +| `--debug-show-memo` | flag | False | Print memo used to recreate the plot. | +| `--challenge-start` | INTEGER | False | Alternate starting challenge index for `-n`. | + +`-g` matches case-sensitive substrings in directory or file names. If omitted, every plot directory from `config.yaml` is scanned. + +
+Example + +```bash +chia plots check -n 30 -g DriveA +chia plots check -l -n 0 +``` + +
+ +### Interpreting proof ratios + +If the ratio of full proofs to expected proofs is greater than 1, the plot looked lucky for this static challenge run; if less than 1, it looked unlucky. This does not mean the plot is invalid on chain. As `-n` increases, the ratio should stabilize. Plot count and k-size matter far more for winning than small ratio swings from `plots check`. + +For DiskProver internals, see [chiapos](https://github.com/Chia-Network/chiapos/blob/main/src/prover_disk.hpp). + +## Related + +- [CLI overview](/reference-client/cli-reference/cli) +- [Plotters CLI](/reference-client/cli-reference/plotter-cli) +- [Harvester CLI](/reference-client/cli-reference/harvester-cli) diff --git a/docs/reference-client/cli-reference/solver-cli.md b/docs/reference-client/cli-reference/solver-cli.md index 4012f5bab4..ec1e218ecb 100644 --- a/docs/reference-client/cli-reference/solver-cli.md +++ b/docs/reference-client/cli-reference/solver-cli.md @@ -4,7 +4,7 @@ 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 ''` like other services (see [RPC overview](/reference-client/rpc-reference/rpc)). +The Solver service accepts JSON-RPC over TLS on port 8667 by default (`solver.rpc_port` in `config.yaml`). HTTP endpoints are documented on [Solver RPC](/reference-client/rpc-reference/solver-rpc). From the shell, call `chia rpc solver ''` like other services (see [RPC overview](/reference-client/rpc-reference/rpc)). Sources: [`chia/cmds/solver.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/solver.py). @@ -14,17 +14,27 @@ Sources: [`chia/cmds/solver.py`](https://github.com/Chia-Network/chia-blockchain Usage: `chia solver get_state [OPTIONS]` -Returns current solver state from the running Solver service. +Returns runtime state from the Solver service. | Option | Description | | :------------------------- | :-------------------------------------------------------- | | `-sp`, `--solver-rpc-port` | Solver RPC port (see `solver.rpc_port` in `config.yaml`). | +
+Example + +```bash +chia solver get_state +chia rpc solver get_state '{}' +``` + +
+ ## 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)) +- RPC: `connect_to_solver` on [Farmer RPC](/reference-client/rpc-reference/farmer-rpc) +- Config: `chia configure --set-solver-peer` and `farmer.solver_peers` (see the configure section on the [CLI overview](/reference-client/cli-reference/cli)) ## Related diff --git a/docs/reference-client/rpc-reference/solver-rpc.md b/docs/reference-client/rpc-reference/solver-rpc.md index de7dbe04b1..3e492af488 100644 --- a/docs/reference-client/rpc-reference/solver-rpc.md +++ b/docs/reference-client/rpc-reference/solver-rpc.md @@ -9,7 +9,7 @@ import TabItem from '@theme/TabItem'; This document provides a comprehensive reference to Chia's Solver RPC API. Routes defined on `SolverRpcApi` are merged with the shared HTTP RPC routes from `RpcServer` (for example connection management, logging, version, and health checks). -The Solver participates in Proof of Space 2 (PoS2) farming with V2 plots. Farmers open a **peer** connection to the solver using [`connect_to_solver`](/reference-client/rpc-reference/farmer-rpc#connect_to_solver) on the farmer RPC (typically peer port **8666**, `solver.port`). **This page documents the Solver's HTTPS JSON-RPC interface** on `solver.rpc_port` (default **8667**). +The Solver participates in Proof of Space 2 (PoS2) farming with V2 plots. Farmers open a peer connection to the solver using `connect_to_solver` on [Farmer RPC](/reference-client/rpc-reference/farmer-rpc) (typically peer port 8666, `solver.port`). This page documents the Solver's HTTPS JSON-RPC interface on `solver.rpc_port` (default 8667). :::note Peer port versus RPC port diff --git a/docs/reference-client/troubleshooting/check-if-things-are-working.md b/docs/reference-client/troubleshooting/check-if-things-are-working.md index 231056605e..3d51000aa3 100644 --- a/docs/reference-client/troubleshooting/check-if-things-are-working.md +++ b/docs/reference-client/troubleshooting/check-if-things-are-working.md @@ -82,7 +82,7 @@ Here are some commands you can use to examine `debug.log` for problems. ## Plotting -You can find the documentation for the `check` command on the [CLI Commands Reference page](/reference-client/cli-reference/cli#plots-check) page +You can find the documentation for the `check` command on the [Plots CLI](/reference-client/cli-reference/plots-cli#plots-check) page - To check all your plots, run `chia plots check`. This will check all directories you have listed in your `config.yaml` to contain plots. - Use `chia plots check -h` to see the options for this command. diff --git a/sidebars.js b/sidebars.js index b945f89950..c68b271589 100644 --- a/sidebars.js +++ b/sidebars.js @@ -284,6 +284,7 @@ module.exports = { 'reference-client/cli-reference/nft-cli', 'reference-client/cli-reference/offer-cli', 'reference-client/cli-reference/plotter-cli', + 'reference-client/cli-reference/plots-cli', 'reference-client/cli-reference/simulator-cli', 'reference-client/cli-reference/solver-cli', 'reference-client/cli-reference/vc-cli', From cc300a8ab43e1980938690e6c0066d9af6ca6cb0 Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Fri, 8 May 2026 09:32:43 -0600 Subject: [PATCH 05/19] docs(cli): align plots-cli with wallet-style examples and options tables Co-authored-by: Cursor --- .../cli-reference/plots-cli.md | 160 +++++++++++++----- 1 file changed, 120 insertions(+), 40 deletions(-) diff --git a/docs/reference-client/cli-reference/plots-cli.md b/docs/reference-client/cli-reference/plots-cli.md index 066e753bf0..e76e35b90f 100644 --- a/docs/reference-client/cli-reference/plots-cli.md +++ b/docs/reference-client/cli-reference/plots-cli.md @@ -4,34 +4,55 @@ title: Plots CLI slug: /reference-client/cli-reference/plots-cli --- -This document describes the `chia plots` command group for listing plot directories, adding and removing search paths, legacy `create`, and `check` validation. For Bladebit, MadMax, and other external plotters, see [Plotters CLI](/reference-client/cli-reference/plotter-cli). +This document lists `chia plots` commands for plot directories, legacy in-process `create`, and `check` validation. For MadMax, Bladebit, and other external plotters, see [Plotters CLI](/reference-client/cli-reference/plotter-cli). Sources: [`chia/cmds/plots.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/plots.py), [`chia/plotting/check_plots.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/plotting/check_plots.py). +## Reference + ## `chia plots show` -Functionality: Print configured plot search directories from `config.yaml` (same paths the harvester uses). +Functionality: Print configured plot search directories from `config.yaml` (the same paths the harvester uses). Usage: `chia plots show`
Example +List directories where the harvester searches for plots: + ```bash chia plots show ``` +Response: + +``` +Directories where plots are being searched for: +Note that subdirectories must be added manually +Add with 'chia plots add -d [dir]' and remove with 'chia plots remove -d [dir]' Scan and check plots with 'chia plots check' + +/home/user/plots +``` + +(Your paths will differ.) +
+--- + ## `chia plots add` -Functionality: Register a directory so the harvester searches it for plots. +Functionality: Register a directory so the harvester includes it when farming. Usage: `chia plots add [OPTIONS]` -| Option | Type | Required | Description | -| :------------------ | :--- | :------- | :----------------------------------- | -| `-d`, `--final_dir` | PATH | False | Plot directory to add (default `.`). | +Options: + +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------ | :--- | :------- | :---------------------------------- | +| `-d` | `--final_dir` | PATH | False | Plot directory to add. Default `.`. | +| `-h` | `--help` | None | False | Show a help message and exit |
Example @@ -40,17 +61,28 @@ Usage: `chia plots add [OPTIONS]` chia plots add -d /mnt/chia/plots ``` +Response: + +``` +Successfully added: /mnt/chia/plots +``` +
+--- + ## `chia plots remove` Functionality: Remove a directory from the configured plot search list. Usage: `chia plots remove [OPTIONS]` -| Option | Type | Required | Description | -| :------------------ | :--- | :------- | :-------------------------------------- | -| `-d`, `--final_dir` | PATH | False | Plot directory to remove (default `.`). | +Options: + +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------ | :--- | :------- | :------------------------------------- | +| `-d` | `--final_dir` | PATH | False | Plot directory to remove. Default `.`. | +| `-h` | `--help` | None | False | Show a help message and exit |
Example @@ -59,33 +91,44 @@ Usage: `chia plots remove [OPTIONS]` chia plots remove -d /mnt/old-plots ``` +Response: + +``` +Successfully removed: /mnt/old-plots +``` +
+--- + ## `chia plots create` -Functionality: Legacy in-process plotting (Chiapos-style). Most users prefer [Plotters CLI](/reference-client/cli-reference/plotter-cli) instead. +Functionality: Legacy in-process plotting (Chiapos-style). Most users should use [Plotters CLI](/reference-client/cli-reference/plotter-cli) instead. Usage: `chia plots create [OPTIONS]` -| Option | Type | Required | Description | -| :------------------------------ | :------ | :------- | :------------------------------------------- | -| `-k`, `--size` | INTEGER | False | Plot k-size (default 32). | -| `--override-k` | flag | False | Allow k-size smaller than 32. | -| `-n`, `--num` | INTEGER | False | Number of plots or challenges (default 1). | -| `-b`, `--buffer` | INTEGER | False | Sort buffer megabytes (default 3389). | -| `-r`, `--num_threads` | INTEGER | False | Thread count (default 2). | -| `-u`, `--buckets` | INTEGER | False | Bucket count (default 128). | -| `-a`, `--alt_fingerprint` | INTEGER | False | Alternative key fingerprint. | -| `-c`, `--pool_contract_address` | TEXT | False | Pool contract address for pool plots. | -| `-f`, `--farmer_public_key` | TEXT | False | Farmer public key hex. | -| `-p`, `--pool_public_key` | TEXT | False | Pool public key hex. | -| `-t`, `--tmp_dir` | PATH | False | Temp directory (default `.`). | -| `-2`, `--tmp2_dir` | PATH | False | Second temp directory. | -| `-d`, `--final_dir` | PATH | False | Final plot directory (default `.`). | -| `-i`, `--plotid` | TEXT | False | Plot ID hex (reproduce plot). | -| `-m`, `--memo` | TEXT | False | Memo hex (reproduce plot). | -| `-e`, `--nobitfield` | flag | False | Disable bitfield. | -| `-x`, `--exclude_final_dir` | flag | False | Do not add final dir to harvester plot list. | +Options: + +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------------ | :------ | :------- | :-------------------------------------------------------------------------- | +| `-k` | `--size` | INTEGER | False | Plot k-size [default: 32] | +| | `--override-k` | None | False | Allow k smaller than 32 (no short flag) | +| `-n` | `--num` | INTEGER | False | Number of plots [default: 1] | +| `-b` | `--buffer` | INTEGER | False | Sort buffer MB [default: 3389] | +| `-r` | `--num_threads` | INTEGER | False | Threads [default: 2] | +| `-u` | `--buckets` | INTEGER | False | Buckets [default: 128] | +| `-a` | `--alt_fingerprint` | INTEGER | False | Alternative key fingerprint | +| `-c` | `--pool_contract_address` | TEXT | False | Pool reward address (when alt fingerprint and pool public key are not used) | +| `-f` | `--farmer_public_key` | TEXT | False | Farmer public key hex | +| `-p` | `--pool_public_key` | TEXT | False | Pool public key hex | +| `-t` | `--tmp_dir` | PATH | False | Temp directory [default: `.`] | +| `-2` | `--tmp2_dir` | PATH | False | Second temp directory | +| `-d` | `--final_dir` | PATH | False | Final plot directory [default: `.`] | +| `-i` | `--plotid` | TEXT | False | Plot ID hex (debug) | +| `-m` | `--memo` | TEXT | False | Memo hex (debug) | +| `-e` | `--nobitfield` | None | False | Disable bitfield | +| `-x` | `--exclude_final_dir` | None | False | Do not add final dir to harvester plot list | +| `-h` | `--help` | None | False | Show a help message and exit |
Example @@ -94,40 +137,77 @@ Usage: `chia plots create [OPTIONS]` chia plots create -k 32 -n 1 -t /tmp/chia -d /plots/final ``` +Response: + +``` +(Plotting progress output; format depends on Chiapos and logging.) +``` +
-## Plots check {#plots-check} +--- + +## `chia plots check` {#plots-check} -Functionality: Validate plots against keys and run repeated challenges to compare observed vs expected proofs. +Functionality: Validate plots against keys and run repeated challenges to compare observed versus expected proofs. Usage: `chia plots check [OPTIONS]` -| Option | Type | Required | Description | -| :------------------------ | :------ | :------- | :---------------------------------------------------- | -| `-n`, `--num` | INTEGER | False | Number of challenges per plot (default 30). | -| `-g`, `--grep_string` | TEXT | False | Only check paths/filenames containing this substring. | -| `-l`, `--list_duplicates` | flag | False | List plots that share the same plot ID. | -| `--debug-show-memo` | flag | False | Print memo used to recreate the plot. | -| `--challenge-start` | INTEGER | False | Alternate starting challenge index for `-n`. | +Options: -`-g` matches case-sensitive substrings in directory or file names. If omitted, every plot directory from `config.yaml` is scanned. +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------ | :------ | :------- | :--------------------------------------------------------- | +| `-n` | `--num` | INTEGER | False | Challenges per plot; omitted uses 30 (same as CLI default) | +| `-g` | `--grep_string` | TEXT | False | Only check paths or filenames containing this substring | +| `-l` | `--list_duplicates` | None | False | List plots that share the same plot ID | +| | `--debug-show-memo` | None | False | Print memo used to recreate the plot | +| | `--challenge-start` | INTEGER | False | Alternate starting challenge index | +| `-h` | `--help` | None | False | Show a help message and exit | + +`-g` is case-sensitive. If omitted, all plot directories from `config.yaml` are scanned.
Example +Run a standard check on paths matching `DriveA`: + ```bash chia plots check -n 30 -g DriveA +``` + +Response: + +``` +(Per-plot challenge results and a summary of proofs versus expected counts.) +``` + +
+ +
+Example + +List duplicate plot IDs only: + +```bash chia plots check -l -n 0 ``` +Response: + +``` +(Output lists any duplicate plot filenames / IDs found.) +``` +
### Interpreting proof ratios -If the ratio of full proofs to expected proofs is greater than 1, the plot looked lucky for this static challenge run; if less than 1, it looked unlucky. This does not mean the plot is invalid on chain. As `-n` increases, the ratio should stabilize. Plot count and k-size matter far more for winning than small ratio swings from `plots check`. +If the ratio of full proofs to expected proofs is greater than 1, the plot looked lucky for this static challenge run; if less than 1, it looked unlucky. That does not mean the plot is invalid on chain. As `-n` increases, the ratio should stabilize. Plot count and k-size matter far more for winning than small swings from `plots check`. For DiskProver internals, see [chiapos](https://github.com/Chia-Network/chiapos/blob/main/src/prover_disk.hpp). +--- + ## Related - [CLI overview](/reference-client/cli-reference/cli) From bbf4a9b8a47abca07620a83ae2d96868d77ee4e7 Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Fri, 8 May 2026 09:32:46 -0600 Subject: [PATCH 06/19] docs(cli): align service CLI pages with Functionality/Usage/Options/Response template Co-authored-by: Cursor --- .../cli-reference/farmer-cli.md | 170 ++++++++++++++---- .../cli-reference/full-node-cli.md | 89 ++++++--- .../cli-reference/harvester-cli.md | 31 +++- .../cli-reference/solver-cli.md | 44 ++++- 4 files changed, 257 insertions(+), 77 deletions(-) diff --git a/docs/reference-client/cli-reference/farmer-cli.md b/docs/reference-client/cli-reference/farmer-cli.md index 322fa9ef9e..7564df2eb2 100644 --- a/docs/reference-client/cli-reference/farmer-cli.md +++ b/docs/reference-client/cli-reference/farmer-cli.md @@ -8,21 +8,24 @@ Commands that query farming and pooling state through the farmer and wallet 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` +## Reference -### `chia farm summary` +## `chia farm summary` + +Functionality: Print farming status: blockchain sync via full node, harvester summaries, plot counts, and wallet-reported farmed amounts when those services are reachable. Usage: `chia farm summary [OPTIONS]` -Prints farming status: blockchain sync via full node, harvester summaries, plot counts, and estimated rewards when services are reachable. +Options: -| 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. | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :----------------------- | :------ | :------- | :--------------------------------------------------------------------- | +| `-p` | `--rpc-port` | INTEGER | False | Full node RPC port (see `full_node.rpc_port` in `config.yaml`). | +| `-wp` | `--wallet-rpc-port` | INTEGER | False | Wallet RPC port (see `wallet.rpc_port`). | +| `-hp` | `--harvester-rpc-port` | INTEGER | False | Harvester RPC port for the local harvester (see `harvester.rpc_port`). | +| `-fp` | `--farmer-rpc-port` | INTEGER | False | Farmer RPC port (see `farmer.rpc_port`). | +| `-i` | `--include-pool-rewards` | None | False | Include pool farming rewards in displayed totals. | +| `-h` | `--help` | None | False | Show a help message and exit. |
Example @@ -32,18 +35,36 @@ chia farm summary chia farm summary -fp 8559 -p 8555 ``` +Response: + +``` +Farming status: Farming +Total chia farmed: 2.5 +User transaction fees: 0.001 +Block rewards: 2.499 +Last height farmed: 1500000 +... +``` + +(Exact lines depend on sync state, services running, and wallet connectivity; connection errors list the RPC port that failed.) +
-### `chia farm challenges` +--- + +## `chia farm challenges` + +Functionality: Print recent signage-point challenges from the farmer. Usage: `chia farm challenges [OPTIONS]` -Shows recent signage point challenges from the farmer. +Options: -| Option | Description | -| :------------------------- | :------------------------------------------------ | -| `-fp`, `--farmer-rpc-port` | Farmer RPC port. | -| `-l`, `--limit` | Max challenges to print (`0` disables the limit). | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------ | :------ | :------- | :------------------------------------------------------------- | +| `-fp` | `--farmer-rpc-port` | INTEGER | False | Farmer RPC port. | +| `-l` | `--limit` | INTEGER | False | Max challenges to print; `0` disables the limit [default: 20]. | +| `-h` | `--help` | None | False | Show a help message and exit. |
Example @@ -52,17 +73,30 @@ Shows recent signage point challenges from the farmer. chia farm challenges -l 10 ``` +Response: + +``` +Hash: 0x... Index: 40 +Hash: 0x... Index: 41 +... +``` +
-### `chia farm connect-solver` {#chia-farm-connect-solver} +--- + +## `chia farm connect-solver` {#chia-farm-connect-solver} + +Functionality: Point the farmer at a Solver service (`host:port`). The same integration is available over farmer RPC as `connect_to_solver` on [Farmer RPC](/reference-client/rpc-reference/farmer-rpc). See also [Solver CLI](/reference-client/cli-reference/solver-cli). Usage: `chia farm connect-solver [OPTIONS] SOLVER_ADDRESS` -Points the farmer at a Solver service (`host:port`). The same integration is available over farmer RPC as `connect_to_solver` on [Farmer RPC](/reference-client/rpc-reference/farmer-rpc). See also [Solver CLI](/reference-client/cli-reference/solver-cli). +Options: -| Option | Description | -| :------------------------- | :--------------- | -| `-fp`, `--farmer-rpc-port` | Farmer RPC port. | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------ | :------ | :------- | :---------------------------- | +| `-fp` | `--farmer-rpc-port` | INTEGER | False | Farmer RPC port. | +| `-h` | `--help` | None | False | Show a help message and exit. |
Example @@ -71,43 +105,105 @@ Points the farmer at a Solver service (`host:port`). The same integration is ava chia farm connect-solver 192.0.2.10:8666 ``` +Response: + +``` +(Confirmation or status from the farmer RPC client; connection errors appear if the farmer is not running.) +``` +
+--- + ## Plot NFT {#plot-nft} -Usage: `chia plotnft [OPTIONS] COMMAND` +The `chia plotnft` group calls the **wallet** RPC for pooling operations. Long options on many subcommands use `--wallet-rpc_port` (underscore), matching `chia plotnft -h` output. + +### `chia plotnft show` + +Functionality: Display launcher IDs, pool URLs, state, and related wallet-side plot NFT details. -Plot NFT commands call the wallet RPC for pooling operations. +Usage: `chia plotnft show [OPTIONS]` -| Command | Purpose | -| :--------------- | :------------------------------------------------------- | -| `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` | Plot NFT details as JSON. | -| `get_login_link` | Pool login link (needs launcher id from `plotnft show`). | +Options: + +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------ | :------ | :------- | :-------------------------------------------------------- | +| `-f` | `--fingerprint` | INTEGER | False | Fingerprint of the wallet to use. | +| `-wp` | `--wallet-rpc_port` | INTEGER | False | Wallet RPC port (see `wallet.rpc_port` in `config.yaml`). | +| `-i` | `--id` | INTEGER | False | Wallet id to use. | +| `-h` | `--help` | None | False | Show a help message and exit. |
-Example: `plotnft show` +Example ```bash -chia plotnft show +chia plotnft show -f 2121994410 +``` + +Response: + +``` +(Multi-line listing of plot NFT wallets, launcher ids, pool state, and URLs — format matches your wallet and plot NFT count.) ```
+### `chia plotnft create` + +Functionality: Create a new plot NFT singleton (self pool or pool farming). + +Usage: `chia plotnft create [OPTIONS]` + +Options: + +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------ | :------ | :------- | :--------------------------------------------------------------------------------- | +| `-f` | `--fingerprint` | INTEGER | False | Fingerprint of the wallet to use. | +| `-wp` | `--wallet-rpc_port` | INTEGER | False | Wallet RPC port. | +| `-s` | `--state` | CHOICE | True | `local` (self-farming) or `pool` (see `chia plotnft create -h`). | +| `-u` | `--pool-url` | TEXT | False | HTTPS host:port of the pool; required when `--state` is `pool`. | +| `-m` | `--fee` | XCH | True | Fee per transaction in XCH (used twice: singleton creation and init) [default: 0]. | +| `-y` | `--yes` | None | False | No prompts. | +| `-h` | `--help` | None | False | Show a help message and exit. | +
-Example: create pool and self-farming plot NFTs +Example + +Create a self-farming plot NFT: + +```bash +chia plotnft create -s local -m 0.00005 +``` + +Create and join a pool (example URL): ```bash -chia plotnft create -u https://pool.example.com -chia plotnft create -s local +chia plotnft create -s pool -u https://pool.example.com -m 0.00005 +``` + +Response: + +``` +(Transaction submission and confirmation prompts or summaries from the wallet — exact text depends on prompts and fees.) ```
-When plotting pool plots, pass the pool contract address from `chia plotnft show` to your plotting command (`-c`), not the legacy pool public key option. +### Other `chia plotnft` subcommands + +| Command | Purpose | +| :--------------------------- | :--------------------------------------------------------- | +| `join` | Join a plot NFT to a pool (`-u` pool URL required). | +| `leave` | Leave a pool and return to self-farming. | +| `claim` | Claim pool rewards. | +| `inspect` | Detailed plot NFT JSON (wallet options `-f`, `-wp`, `-i`). | +| `get_login_link` | Pool login link (`-l` / `--launcher_id` required). | +| `change_payout_instructions` | Update payout address (`-l` launcher id, `-a` address). | + +Run `chia plotnft -h` for the full option table of each subcommand. + +When plotting **pool** plots, pass the **pool contract address** from `chia plotnft show` to your plotter (`-c`), not the legacy pool public key option. ## Related diff --git a/docs/reference-client/cli-reference/full-node-cli.md b/docs/reference-client/cli-reference/full-node-cli.md index f46304d50d..86102b03dd 100644 --- a/docs/reference-client/cli-reference/full-node-cli.md +++ b/docs/reference-client/cli-reference/full-node-cli.md @@ -8,26 +8,41 @@ Commands that talk to the full node use its RPC interface (default port 8555, `f 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). +## Reference + ## `chia show` -Usage: `chia show [OPTIONS]` +Functionality: Query blockchain and fee data through the full node. At least one main option is required (`no_args_is_help`); legacy connection flags still parse but print migration hints. -Shows blockchain and fee information via the full node. At least one option is required (`no_args_is_help`). +Usage: `chia show [OPTIONS]` -| 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`). | +Options: + +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------------------ | :------ | :------- | :-------------------------------------------------------------- | +| `-p` | `--rpc-port` | INTEGER | False | Full node RPC port (see `full_node.rpc_port` in `config.yaml`). | +| `-wp` | `--wallet-rpc-port` | INTEGER | False | Parsed for compatibility; prints a message that it is unused. | +| `-f` | `--fee` | None | False | Show fee information. | +| `-s` | `--state` | None | False | Show current blockchain state (sync, peak, recent headers). | +| `-c` | `--connections` | None | False | Renamed: prints guidance to use `chia peer full_node -c`. | +| `-a` | `--add-connection` | TEXT | False | Renamed: prints guidance to use `chia peer full_node -a`. | +| `-r` | `--remove-connection` | TEXT | False | Renamed: prints guidance to use `chia peer full_node -r`. | +| `-bh` | `--block-header-hash-by-height` | INTEGER | False | Look up a block header hash by height. | +| `-b` | `--block-by-header-hash` | TEXT | False | Look up a block by header hash. | +| `-h` | `--help` | None | False | Show a help message and exit. |
Example ```bash chia show -s -chia show --fee +chia show -f +``` + +Response: + +``` +(Current blockchain state or fee tables from the full node; format is multi-line text and JSON-like summaries from RPC responses.) ```
@@ -38,17 +53,22 @@ chia show --fee ::: +--- + ## `chia netspace` +Functionality: Estimate total network space from full node chain data. + Usage: `chia netspace [OPTIONS]` -Estimates total network space from full node chain data. +Options: -| 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). | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :--------------------- | :------ | :------- | :---------------------------------------------------------------------------- | +| `-p` | `--rpc-port` | INTEGER | False | Full node RPC port. | +| `-d` | `--delta-block-height` | TEXT | False | Block spacing for the estimate [default: 4608]. Use `192` for about one hour. | +| `-s` | `--start` | TEXT | False | Newest block height to anchor the calculation (default: peak). | +| `-h` | `--help` | None | False | Show a help message and exit. |
Example @@ -57,20 +77,33 @@ Estimates total network space from full node chain data. chia netspace -d 192 ``` +Response: + +``` +(Estimated effective farm space over the chosen window, printed from the netspace helper.) +``` +
+--- + ## `chia peer full_node` -Usage: `chia peer full_node [OPTIONS]` +Functionality: Inspect or change full node peer connections (same RPC service as `chia show`). + +Usage: `chia peer [OPTIONS] NODE_TYPE` -Inspect or change full node peer connections (same RPC service as `chia show`). +Use `full_node` as `NODE_TYPE` for full-node peers. Supported values include `base`, `farmer`, `wallet`, `full_node`, `harvester`, `data_layer`, `simulator`, and `solver` (see `chia peer -h`). -| 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. | +Options: + +| Short Command | Long Command | Type | Required | Description | +| :------------ | :-------------------- | :------ | :------- | :---------------------------------------------------------------- | +| `-p` | `--rpc-port` | INTEGER | False | RPC port for the service you address (`full_node.rpc_port` here). | +| `-c` | `--connections` | None | False | List peers connected to this node type. | +| `-a` | `--add-connection` | TEXT | False | Connect to another node `ip:port`. | +| `-r` | `--remove-connection` | TEXT | False | Remove a peer by the first 8 characters of its node id. | +| `-h` | `--help` | None | False | Show a help message and exit. |
Example @@ -80,9 +113,15 @@ chia peer full_node -c chia peer full_node -a 203.0.113.5:8444 ``` +Response: + +``` +(List of peers or confirmation after add/remove; errors surface TLS or connectivity problems.) +``` +
-Other `chia peer ` 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. +Other `chia peer ` targets (`farmer`, `wallet`, `harvester`, `data_layer`, `simulator`, `solver`, …) use the same option shape with that service’s RPC port — see [Farmer CLI](/reference-client/cli-reference/farmer-cli), [Harvester CLI](/reference-client/cli-reference/harvester-cli), and related pages. ## Related diff --git a/docs/reference-client/cli-reference/harvester-cli.md b/docs/reference-client/cli-reference/harvester-cli.md index db475fa8fd..1cfc33afed 100644 --- a/docs/reference-client/cli-reference/harvester-cli.md +++ b/docs/reference-client/cli-reference/harvester-cli.md @@ -4,22 +4,29 @@ title: Harvester CLI slug: /reference-client/cli-reference/harvester-cli --- -There is no top-level `chia harvester` group. Start the harvester with `chia start harvester` (see the `start` section on the [CLI overview](/reference-client/cli-reference/cli)) or via groups such as `farmer`. CLI operations below use the harvester RPC (default port 8560, `harvester.rpc_port`) or plot paths from `config.yaml`. +There is no top-level `chia harvester` command group. Start the harvester with `chia start harvester` (see the `start` section on the [CLI overview](/reference-client/cli-reference/cli)) or via groups such as `farmer`. CLI operations below use the harvester RPC (default port 8560, `harvester.rpc_port`) or plot paths from `config.yaml`. HTTP JSON-RPC methods and payloads are documented on [Harvester RPC](/reference-client/rpc-reference/harvester-rpc). Use `chia rpc harvester ''` the same way as other services (see [RPC overview](/reference-client/rpc-reference/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). +## Reference + ## `chia peer harvester` -Usage: `chia peer harvester [OPTIONS]` +Functionality: List or modify peer connections for the harvester RPC service. + +Usage: `chia peer [OPTIONS] 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. | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :-------------------- | :------ | :------- | :-------------------------------------------------- | +| `-p` | `--rpc-port` | INTEGER | False | Harvester RPC port (`harvester.rpc_port`). | +| `-c` | `--connections` | None | False | List connections for this harvester. | +| `-a` | `--add-connection` | TEXT | False | Add a connection `ip:port`. | +| `-r` | `--remove-connection` | TEXT | False | Remove a peer by the first 8 characters of node id. | +| `-h` | `--help` | None | False | Show a help message and exit. |
Example @@ -28,8 +35,16 @@ Usage: `chia peer harvester [OPTIONS]` chia peer harvester -c ``` +Response: + +``` +(List of peers reported by the harvester RPC; empty if only local farming.) +``` +
+--- + ## Plot directories The harvester reads plot search paths from configuration. Manage directories with `chia plots` on [Plots CLI](/reference-client/cli-reference/plots-cli) (`show`, `add`, `remove`, `check`). diff --git a/docs/reference-client/cli-reference/solver-cli.md b/docs/reference-client/cli-reference/solver-cli.md index ec1e218ecb..acc8967e2f 100644 --- a/docs/reference-client/cli-reference/solver-cli.md +++ b/docs/reference-client/cli-reference/solver-cli.md @@ -8,26 +8,56 @@ The Solver service accepts JSON-RPC over TLS on port 8667 by default (`solver.rp Sources: [`chia/cmds/solver.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/solver.py). -## `chia solver` +## Reference -### `chia solver get_state` +## `chia solver get_state` + +Functionality: Return runtime state from the Solver service over the CLI helper (same data as `chia rpc solver get_state`). Usage: `chia solver get_state [OPTIONS]` -Returns runtime state from the Solver service. +Options: -| Option | Description | -| :------------------------- | :-------------------------------------------------------- | -| `-sp`, `--solver-rpc-port` | Solver RPC port (see `solver.rpc_port` in `config.yaml`). | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------ | :------ | :------- | :-------------------------------------------------------- | +| `-sp` | `--solver-rpc-port` | INTEGER | False | Solver RPC port (see `solver.rpc_port` in `config.yaml`). | +| `-h` | `--help` | None | False | Show a help message and exit. |
-Example +Example (CLI) ```bash chia solver get_state +chia solver get_state -sp 8667 +``` + +Response: + +``` +(JSON-style solver status when the service is running; if the solver is stopped you get a connection error naming the host and port.) +``` + +
+ +
+Example (`chia rpc`) + +See also Windows quoting notes on [RPC overview](/reference-client/rpc-reference/rpc). + +```bash chia rpc solver get_state '{}' ``` +Response: + +```json +{ + "started": true +} +``` + +When TLS services are down, the client prints a connection error instead of JSON. +
## Farmer integration From 49ee053f210978c68ae8bdb81eb911fa1ea1c39f Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Fri, 8 May 2026 09:32:49 -0600 Subject: [PATCH 07/19] docs(cli): add Response blocks and options tables for plotnft and db hub sections Co-authored-by: Cursor --- docs/reference-client/cli-reference/cli.md | 71 ++++++++++++++++------ 1 file changed, 53 insertions(+), 18 deletions(-) diff --git a/docs/reference-client/cli-reference/cli.md b/docs/reference-client/cli-reference/cli.md index c09a8cefde..c65aace0fe 100644 --- a/docs/reference-client/cli-reference/cli.md +++ b/docs/reference-client/cli-reference/cli.md @@ -168,6 +168,7 @@ Options: -h, --help Show this message and exit. Commands: + change_payout_instructions Change the payout instructions for a pool. claim Claim rewards from a plot NFT create Create a plot NFT get_login_link Create a login link for a pool. To get the launcher id, use plotnft show. @@ -182,8 +183,14 @@ Commands: ```bash chia plotnft show -chia plotnft create -u https://pool.example.com -chia plotnft create -s local +chia plotnft create -s pool -u https://pool.example.com -m 0.00005 +chia plotnft create -s local -m 0.00005 +``` + +Response: + +``` +(Multi-line plot NFT status from `show`, or transaction output from `create` — see [Farmer CLI](/reference-client/cli-reference/farmer-cli#plot-nft) for the full option tables.) ``` @@ -200,17 +207,19 @@ The `chia db` commands upgrade the blockchain database format, create a vacuumed Implementation: [`db_upgrade_cmd`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/db.py) -Command: `chia db upgrade [OPTIONS]` - -**Flags** - -`--input [PATH]`: Optional v1 database input file. +Functionality: Upgrade a v1 blockchain SQLite database to the v2 format. -`--output [PATH]`: Optional v2 output path (must not exist unless workflow allows). +Usage: `chia db upgrade [OPTIONS]` -`--no-update-config`: Do not rewrite `config.yaml` to point at the new database (also applies when using a custom output path in typical setups). +Options: -`--force`: Proceed despite warnings when the upgrade tool would otherwise stop. +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------- | :--- | :------- | :----------------------------------------------------------------------------------------------------- | +| | `--input` | PATH | False | Input database file (defaults follow the upgrade tool when omitted). | +| | `--output` | PATH | False | Output database file (must not exist unless the workflow allows overwriting). | +| | `--no-update-config` | None | False | Do not update `config.yaml` to point at the new database (also applies with many custom output paths). | +| | `--force` | None | False | Force conversion despite warnings. | +| `-h` | `--help` | None | False | Show a help message and exit. | **Database upgrade notes** @@ -229,19 +238,29 @@ chia db upgrade chia db upgrade --input ~/.chia/mainnet/db/blockchain_v1_mainnet.sqlite --output ~/.chia/mainnet/db/blockchain_v2_mainnet.sqlite ``` +Response: + +``` +(Progress and completion messages from the upgrade tool; failures print FAILED: … with a reason.) +``` + ### backup {#backup} Implementation: [`db_backup_cmd`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/db.py) -Command: `chia db backup [OPTIONS]` +Functionality: Create a vacuumed backup of the blockchain database using SQLite `VACUUM INTO`. -**Flags** +Usage: `chia db backup [OPTIONS]` -`--backup_file [PATH]`: Optional backup path. Default writes next to the active database. +Options: -`--no_indexes`: Write the backup without indexes. +| Short Command | Long Command | Type | Required | Description | +| :------------ | :-------------- | :--- | :------- | :------------------------------------------------------------- | +| | `--backup_file` | PATH | False | Backup destination path (default next to the active database). | +| | `--no_indexes` | None | False | Create backup without indexes. | +| `-h` | `--help` | None | False | Show a help message and exit. | **Database backup notes** @@ -258,19 +277,29 @@ chia db backup chia db backup --backup_file ~/chia-db-backup.sqlite ``` +Response: + +``` +(Status lines from the vacuum/backup step; long runs may take hours on large databases.) +``` + ### validate {#validate} Implementation: [`db_validate_cmd`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/db.py) -Command: `chia db validate [OPTIONS]` +Functionality: Validate the v2 blockchain database structure (does not verify proofs). -**Flags** +Usage: `chia db validate [OPTIONS]` -`--db [PATH]`: Database file to validate (defaults to the configured blockchain database). +Options: -`--validate-blocks`: Also validate encoded blocks and block records (slower). +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------ | :--- | :------- | :-------------------------------------------------------------------------- | +| | `--db` | PATH | False | Database file to validate (defaults to the configured blockchain database). | +| | `--validate-blocks` | None | False | Also validate encoded blocks and block records (slower). | +| `-h` | `--help` | None | False | Show a help message and exit. | **Database validate notes** @@ -286,6 +315,12 @@ chia db validate chia db validate --validate-blocks ``` +Response: + +``` +(Validation progress from tip toward genesis; failures print FAILED: … .) +``` + ## keys {#keys} From 430acea43645804c8fcb59ee5f7e598571063bb7 Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Fri, 8 May 2026 09:33:41 -0600 Subject: [PATCH 08/19] docs(cli): restore pool contract address wording for plots create -c Co-authored-by: Cursor --- .../cli-reference/plots-cli.md | 40 +++++++++---------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/reference-client/cli-reference/plots-cli.md b/docs/reference-client/cli-reference/plots-cli.md index e76e35b90f..9647b3e234 100644 --- a/docs/reference-client/cli-reference/plots-cli.md +++ b/docs/reference-client/cli-reference/plots-cli.md @@ -109,26 +109,26 @@ Usage: `chia plots create [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------------ | :------ | :------- | :-------------------------------------------------------------------------- | -| `-k` | `--size` | INTEGER | False | Plot k-size [default: 32] | -| | `--override-k` | None | False | Allow k smaller than 32 (no short flag) | -| `-n` | `--num` | INTEGER | False | Number of plots [default: 1] | -| `-b` | `--buffer` | INTEGER | False | Sort buffer MB [default: 3389] | -| `-r` | `--num_threads` | INTEGER | False | Threads [default: 2] | -| `-u` | `--buckets` | INTEGER | False | Buckets [default: 128] | -| `-a` | `--alt_fingerprint` | INTEGER | False | Alternative key fingerprint | -| `-c` | `--pool_contract_address` | TEXT | False | Pool reward address (when alt fingerprint and pool public key are not used) | -| `-f` | `--farmer_public_key` | TEXT | False | Farmer public key hex | -| `-p` | `--pool_public_key` | TEXT | False | Pool public key hex | -| `-t` | `--tmp_dir` | PATH | False | Temp directory [default: `.`] | -| `-2` | `--tmp2_dir` | PATH | False | Second temp directory | -| `-d` | `--final_dir` | PATH | False | Final plot directory [default: `.`] | -| `-i` | `--plotid` | TEXT | False | Plot ID hex (debug) | -| `-m` | `--memo` | TEXT | False | Memo hex (debug) | -| `-e` | `--nobitfield` | None | False | Disable bitfield | -| `-x` | `--exclude_final_dir` | None | False | Do not add final dir to harvester plot list | -| `-h` | `--help` | None | False | Show a help message and exit | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------------ | :------ | :------- | :------------------------------------------------------------------------------------------- | +| `-k` | `--size` | INTEGER | False | Plot k-size [default: 32] | +| | `--override-k` | None | False | Allow k smaller than 32 (no short flag) | +| `-n` | `--num` | INTEGER | False | Number of plots [default: 1] | +| `-b` | `--buffer` | INTEGER | False | Sort buffer MB [default: 3389] | +| `-r` | `--num_threads` | INTEGER | False | Threads [default: 2] | +| `-u` | `--buckets` | INTEGER | False | Buckets [default: 128] | +| `-a` | `--alt_fingerprint` | INTEGER | False | Alternative key fingerprint | +| `-c` | `--pool_contract_address` | TEXT | False | Pool contract address (only used if alternative fingerprint and pool public key are not set) | +| `-f` | `--farmer_public_key` | TEXT | False | Farmer public key hex | +| `-p` | `--pool_public_key` | TEXT | False | Pool public key hex | +| `-t` | `--tmp_dir` | PATH | False | Temp directory [default: `.`] | +| `-2` | `--tmp2_dir` | PATH | False | Second temp directory | +| `-d` | `--final_dir` | PATH | False | Final plot directory [default: `.`] | +| `-i` | `--plotid` | TEXT | False | Plot ID hex (debug) | +| `-m` | `--memo` | TEXT | False | Memo hex (debug) | +| `-e` | `--nobitfield` | None | False | Disable bitfield | +| `-x` | `--exclude_final_dir` | None | False | Do not add final dir to harvester plot list | +| `-h` | `--help` | None | False | Show a help message and exit |
Example From 3e0dfa96375a827651e0e543994be041e938e2e7 Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Fri, 8 May 2026 09:40:35 -0600 Subject: [PATCH 09/19] docs(cli): wrap plots-cli examples in mdx-code-block for Crowdin Co-authored-by: Cursor --- .../cli-reference/plots-cli.md | 36 +++++++++++++++---- 1 file changed, 30 insertions(+), 6 deletions(-) diff --git a/docs/reference-client/cli-reference/plots-cli.md b/docs/reference-client/cli-reference/plots-cli.md index 9647b3e234..53f2ccdcba 100644 --- a/docs/reference-client/cli-reference/plots-cli.md +++ b/docs/reference-client/cli-reference/plots-cli.md @@ -21,19 +21,23 @@ Usage: `chia plots show` List directories where the harvester searches for plots: +````mdx-code-block ```bash chia plots show ``` +```` Response: -``` +````mdx-code-block +```text Directories where plots are being searched for: Note that subdirectories must be added manually Add with 'chia plots add -d [dir]' and remove with 'chia plots remove -d [dir]' Scan and check plots with 'chia plots check' /home/user/plots ``` +```` (Your paths will differ.) @@ -57,15 +61,19 @@ Options:
Example +````mdx-code-block ```bash chia plots add -d /mnt/chia/plots ``` +```` Response: -``` +````mdx-code-block +```text Successfully added: /mnt/chia/plots ``` +````
@@ -87,15 +95,19 @@ Options:
Example +````mdx-code-block ```bash chia plots remove -d /mnt/old-plots ``` +```` Response: -``` +````mdx-code-block +```text Successfully removed: /mnt/old-plots ``` +````
@@ -133,15 +145,19 @@ Options:
Example +````mdx-code-block ```bash chia plots create -k 32 -n 1 -t /tmp/chia -d /plots/final ``` +```` Response: -``` +````mdx-code-block +```text (Plotting progress output; format depends on Chiapos and logging.) ``` +````
@@ -171,15 +187,19 @@ Options: Run a standard check on paths matching `DriveA`: +````mdx-code-block ```bash chia plots check -n 30 -g DriveA ``` +```` Response: -``` +````mdx-code-block +```text (Per-plot challenge results and a summary of proofs versus expected counts.) ``` +````
@@ -188,15 +208,19 @@ Response: List duplicate plot IDs only: +````mdx-code-block ```bash chia plots check -l -n 0 ``` +```` Response: -``` +````mdx-code-block +```text (Output lists any duplicate plot filenames / IDs found.) ``` +```` From 09bdf2a71df3e4c322a8b13f4d34fb4302d554af Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Fri, 8 May 2026 09:40:39 -0600 Subject: [PATCH 10/19] docs(cli): wrap service CLI examples in mdx-code-block for Crowdin Co-authored-by: Cursor --- .../cli-reference/farmer-cli.md | 32 ++++++++++++++++--- .../cli-reference/full-node-cli.md | 18 +++++++++-- .../cli-reference/harvester-cli.md | 6 +++- .../cli-reference/solver-cli.md | 10 +++++- 4 files changed, 56 insertions(+), 10 deletions(-) diff --git a/docs/reference-client/cli-reference/farmer-cli.md b/docs/reference-client/cli-reference/farmer-cli.md index 7564df2eb2..f53b57993a 100644 --- a/docs/reference-client/cli-reference/farmer-cli.md +++ b/docs/reference-client/cli-reference/farmer-cli.md @@ -30,14 +30,17 @@ Options:
Example +````mdx-code-block ```bash chia farm summary chia farm summary -fp 8559 -p 8555 ``` +```` Response: -``` +````mdx-code-block +```text Farming status: Farming Total chia farmed: 2.5 User transaction fees: 0.001 @@ -45,6 +48,7 @@ Block rewards: 2.499 Last height farmed: 1500000 ... ``` +```` (Exact lines depend on sync state, services running, and wallet connectivity; connection errors list the RPC port that failed.) @@ -69,17 +73,21 @@ Options:
Example +````mdx-code-block ```bash chia farm challenges -l 10 ``` +```` Response: -``` +````mdx-code-block +```text Hash: 0x... Index: 40 Hash: 0x... Index: 41 ... ``` +````
@@ -101,15 +109,19 @@ Options:
Example +````mdx-code-block ```bash chia farm connect-solver 192.0.2.10:8666 ``` +```` Response: -``` +````mdx-code-block +```text (Confirmation or status from the farmer RPC client; connection errors appear if the farmer is not running.) ``` +````
@@ -137,15 +149,19 @@ Options:
Example +````mdx-code-block ```bash chia plotnft show -f 2121994410 ``` +```` Response: -``` +````mdx-code-block +```text (Multi-line listing of plot NFT wallets, launcher ids, pool state, and URLs — format matches your wallet and plot NFT count.) ``` +````
@@ -172,21 +188,27 @@ Options: Create a self-farming plot NFT: +````mdx-code-block ```bash chia plotnft create -s local -m 0.00005 ``` +```` Create and join a pool (example URL): +````mdx-code-block ```bash chia plotnft create -s pool -u https://pool.example.com -m 0.00005 ``` +```` Response: -``` +````mdx-code-block +```text (Transaction submission and confirmation prompts or summaries from the wallet — exact text depends on prompts and fees.) ``` +````
diff --git a/docs/reference-client/cli-reference/full-node-cli.md b/docs/reference-client/cli-reference/full-node-cli.md index 86102b03dd..e35a72ce73 100644 --- a/docs/reference-client/cli-reference/full-node-cli.md +++ b/docs/reference-client/cli-reference/full-node-cli.md @@ -34,16 +34,20 @@ Options:
Example +````mdx-code-block ```bash chia show -s chia show -f ``` +```` Response: -``` +````mdx-code-block +```text (Current blockchain state or fee tables from the full node; format is multi-line text and JSON-like summaries from RPC responses.) ``` +````
@@ -73,15 +77,19 @@ Options:
Example +````mdx-code-block ```bash chia netspace -d 192 ``` +```` Response: -``` +````mdx-code-block +```text (Estimated effective farm space over the chosen window, printed from the netspace helper.) ``` +````
@@ -108,16 +116,20 @@ Options:
Example +````mdx-code-block ```bash chia peer full_node -c chia peer full_node -a 203.0.113.5:8444 ``` +```` Response: -``` +````mdx-code-block +```text (List of peers or confirmation after add/remove; errors surface TLS or connectivity problems.) ``` +````
diff --git a/docs/reference-client/cli-reference/harvester-cli.md b/docs/reference-client/cli-reference/harvester-cli.md index 1cfc33afed..71ddc45953 100644 --- a/docs/reference-client/cli-reference/harvester-cli.md +++ b/docs/reference-client/cli-reference/harvester-cli.md @@ -31,15 +31,19 @@ Options:
Example +````mdx-code-block ```bash chia peer harvester -c ``` +```` Response: -``` +````mdx-code-block +```text (List of peers reported by the harvester RPC; empty if only local farming.) ``` +````
diff --git a/docs/reference-client/cli-reference/solver-cli.md b/docs/reference-client/cli-reference/solver-cli.md index acc8967e2f..0f68e88bf1 100644 --- a/docs/reference-client/cli-reference/solver-cli.md +++ b/docs/reference-client/cli-reference/solver-cli.md @@ -26,16 +26,20 @@ Options:
Example (CLI) +````mdx-code-block ```bash chia solver get_state chia solver get_state -sp 8667 ``` +```` Response: -``` +````mdx-code-block +```text (JSON-style solver status when the service is running; if the solver is stopped you get a connection error naming the host and port.) ``` +````
@@ -44,17 +48,21 @@ Response: See also Windows quoting notes on [RPC overview](/reference-client/rpc-reference/rpc). +````mdx-code-block ```bash chia rpc solver get_state '{}' ``` +```` Response: +````mdx-code-block ```json { "started": true } ``` +```` When TLS services are down, the client prints a connection error instead of JSON. From 1f88402c3c0b189bd1baf86ff26622f83c03ec0d Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Fri, 8 May 2026 09:40:43 -0600 Subject: [PATCH 11/19] docs(cli): wrap cli hub plotnft/db listings in mdx-code-block for Crowdin Co-authored-by: Cursor --- docs/reference-client/cli-reference/cli.md | 26 ++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/docs/reference-client/cli-reference/cli.md b/docs/reference-client/cli-reference/cli.md index c65aace0fe..0866467dcc 100644 --- a/docs/reference-client/cli-reference/cli.md +++ b/docs/reference-client/cli-reference/cli.md @@ -161,6 +161,7 @@ The cli reference for all plotters can be found in the [Plotters CLI Page](/refe Subcommands from `chia plotnft -h`: +````mdx-code-block ```text Usage: chia plotnft [OPTIONS] COMMAND [ARGS]... @@ -177,21 +178,26 @@ Commands: leave Leave a pool and return to self-farming show Show plotnft information ``` +````
Example +````mdx-code-block ```bash chia plotnft show chia plotnft create -s pool -u https://pool.example.com -m 0.00005 chia plotnft create -s local -m 0.00005 ``` +```` Response: -``` +````mdx-code-block +```text (Multi-line plot NFT status from `show`, or transaction output from `create` — see [Farmer CLI](/reference-client/cli-reference/farmer-cli#plot-nft) for the full option tables.) ``` +````
@@ -233,16 +239,20 @@ Options:
Example +````mdx-code-block ```bash chia db upgrade chia db upgrade --input ~/.chia/mainnet/db/blockchain_v1_mainnet.sqlite --output ~/.chia/mainnet/db/blockchain_v2_mainnet.sqlite ``` +```` Response: -``` +````mdx-code-block +```text (Progress and completion messages from the upgrade tool; failures print FAILED: … with a reason.) ``` +````
@@ -272,16 +282,20 @@ Options:
Example +````mdx-code-block ```bash chia db backup chia db backup --backup_file ~/chia-db-backup.sqlite ``` +```` Response: -``` +````mdx-code-block +```text (Status lines from the vacuum/backup step; long runs may take hours on large databases.) ``` +````
@@ -310,16 +324,20 @@ Options:
Example +````mdx-code-block ```bash chia db validate chia db validate --validate-blocks ``` +```` Response: -``` +````mdx-code-block +```text (Validation progress from tip toward genesis; failures print FAILED: … .) ``` +````
From 02cc9de19ce478350d17e2fcb9c7614225c7ae76 Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Fri, 8 May 2026 09:44:34 -0600 Subject: [PATCH 12/19] docs(cli): use source-derived stdout/log samples in plots-cli responses Co-authored-by: Cursor --- .../cli-reference/plots-cli.md | 54 +++++++++++++------ 1 file changed, 38 insertions(+), 16 deletions(-) diff --git a/docs/reference-client/cli-reference/plots-cli.md b/docs/reference-client/cli-reference/plots-cli.md index 53f2ccdcba..537da7a26b 100644 --- a/docs/reference-client/cli-reference/plots-cli.md +++ b/docs/reference-client/cli-reference/plots-cli.md @@ -6,7 +6,7 @@ slug: /reference-client/cli-reference/plots-cli This document lists `chia plots` commands for plot directories, legacy in-process `create`, and `check` validation. For MadMax, Bladebit, and other external plotters, see [Plotters CLI](/reference-client/cli-reference/plotter-cli). -Sources: [`chia/cmds/plots.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/plots.py), [`chia/plotting/check_plots.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/plotting/check_plots.py). +Sources: [`chia/cmds/plots.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/plots.py), [`chia/plotting/check_plots.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/plotting/check_plots.py), [`chia/plotting/create_plots.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/plotting/create_plots.py). ## Reference @@ -19,8 +19,6 @@ Usage: `chia plots show`
Example -List directories where the harvester searches for plots: - ````mdx-code-block ```bash chia plots show @@ -29,6 +27,8 @@ chia plots show Response: +Output is printed by [`show_plots`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/plots.py): + ````mdx-code-block ```text Directories where plots are being searched for: @@ -39,7 +39,7 @@ Add with 'chia plots add -d [dir]' and remove with 'chia plots remove -d [dir]' ``` ```` -(Your paths will differ.) +(Additional lines list each configured directory; only non-empty paths appear after the blank line.)
@@ -69,12 +69,16 @@ chia plots add -d /mnt/chia/plots Response: +[`add_cmd`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/plots.py) prints on success: + ````mdx-code-block ```text Successfully added: /mnt/chia/plots ``` ```` +Invalid paths raise before printing (`Path doesn't exist`, etc., from [`add_plot_directory`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/util/harvester_config.py)). + --- @@ -103,11 +107,7 @@ chia plots remove -d /mnt/old-plots Response: -````mdx-code-block -```text -Successfully removed: /mnt/old-plots -``` -```` +[`remove_cmd`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/plots.py) calls [`remove_plot_directory`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/util/harvester_config.py) only; there is **no** `print` on success, so stdout is empty. @@ -153,12 +153,18 @@ chia plots create -k 32 -n 1 -t /tmp/chia -d /plots/final Response: +Chiapos progress goes to logging. After plotting, [`create_plots`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/plotting/create_plots.py) emits summary lines such as: + ````mdx-code-block ```text -(Plotting progress output; format depends on Chiapos and logging.) +Summary: +Created a total of 1 new plots +plot-k32-2024-01-15-xxxxx.plot ``` ```` +(Exact filenames and timestamps vary; intermediate output comes from `DiskPlotter` / chiapos.) + --- @@ -185,8 +191,6 @@ Options:
Example -Run a standard check on paths matching `DriveA`: - ````mdx-code-block ```bash chia plots check -n 30 -g DriveA @@ -195,19 +199,29 @@ chia plots check -n 30 -g DriveA Response: +[`check_plots`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/plotting/check_plots.py) logs progress (default log level INFO). Representative lines: + ````mdx-code-block ```text -(Per-plot challenge results and a summary of proofs versus expected counts.) +Loading plots in config.yaml using plot_manager loading code (parallel read: true) + +Starting to test each plot with 30 challenges each + +Testing plot /plots/foo/plot-k32-....plot k=32 + Pool contract address: xch1... + Farmer public key: ... + Local sk: ... + Looking up qualities took: 12 ms. Filepath: /plots/foo/plot-k32-....plot ``` ```` +(Per-plot lines repeat; proof counts and ratios appear in later log lines.) +
Example -List duplicate plot IDs only: - ````mdx-code-block ```bash chia plots check -l -n 0 @@ -216,12 +230,20 @@ chia plots check -l -n 0 Response: +With `-l`, [`find_duplicate_plot_IDs`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/plotting/util.py) logs duplicates; with `-n 0` no challenges run after duplicate detection. Example duplicate warning shape: + ````mdx-code-block ```text -(Output lists any duplicate plot filenames / IDs found.) +Checking for duplicate Plot IDs +Plot filenames expected to end with -[64 char plot ID].plot +abc...69chars....plot found in multiple files: + /path/first.plot + /path/second.plot ``` ```` +If there are no duplicate IDs, you may only see the initial “Checking for duplicate Plot IDs” messages. +
### Interpreting proof ratios From cbc1764eb37444498993479b4bcda1ecf6fa2c90 Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Fri, 8 May 2026 09:44:37 -0600 Subject: [PATCH 13/19] docs(cli): use source-derived farm and plotnft example responses Co-authored-by: Cursor --- .../cli-reference/farmer-cli.md | 67 +++++++++++++------ 1 file changed, 46 insertions(+), 21 deletions(-) diff --git a/docs/reference-client/cli-reference/farmer-cli.md b/docs/reference-client/cli-reference/farmer-cli.md index f53b57993a..60b8352656 100644 --- a/docs/reference-client/cli-reference/farmer-cli.md +++ b/docs/reference-client/cli-reference/farmer-cli.md @@ -6,7 +6,7 @@ slug: /reference-client/cli-reference/farmer-cli Commands that query farming and pooling state through the farmer and wallet RPC clients. Default farmer RPC port is 8559 (`farmer.rpc_port`). JSON-RPC methods are documented on [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). +Sources: [`chia/cmds/farm.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/farm.py), [`chia/cmds/farm_funcs.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/farm_funcs.py), [`chia/cmds/plotnft.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/plotnft.py), [`chia/cmds/plotnft_funcs.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/plotnft_funcs.py). ## Reference @@ -39,18 +39,26 @@ chia farm summary -fp 8559 -p 8555 Response: +Shape follows [`summary`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/farm_funcs.py) (`print` calls). Illustrative synced farm with one local harvester (amounts and sizes vary): + ````mdx-code-block ```text Farming status: Farming Total chia farmed: 2.5 User transaction fees: 0.001 Block rewards: 2.499 -Last height farmed: 1500000 -... +Last height farmed: 4100000 +Local Harvester + 120 plots of size: 12.345 TiB on-disk, 11.800 TiBe (effective) +Plot count for all harvesters: 120 +Total size of plots: 12.345 TiB, 11.800 TiBe (effective) +Estimated network space: 20.000 EiB +Expected time to win: 3 weeks +Note: log into your key using 'chia wallet show' to see rewards for each key ``` ```` -(Exact lines depend on sync state, services running, and wallet connectivity; connection errors list the RPC port that failed.) +Other branches print different first lines for `Farming status:` (`Not available`, `Syncing`, `Not synced or not connected to peers`, `Not running`). If the farmer RPC is down: `Plot count: Unknown` / `Total size of plots: Unknown` / `Estimated network space: Unknown`. Wallet offline shows `For details on farmed rewards and fees you should run 'chia start wallet'...`. @@ -81,11 +89,12 @@ chia farm challenges -l 10 Response: +Each line is formatted in [`challenges`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/farm_funcs.py): + ````mdx-code-block ```text -Hash: 0x... Index: 40 -Hash: 0x... Index: 41 -... +Hash: 0xa1b2c3d4e5f6789012345678901234567890abcd1234567890abcd1234567890 Index: 42 +Hash: 0xb2c3d4e5f6789012345678901234567890abcd1234567890abcd1234567890ab Index: 43 ``` ```` @@ -117,12 +126,17 @@ chia farm connect-solver 192.0.2.10:8666 Response: +[`solver_connect`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/farm_funcs.py) on success: + ````mdx-code-block ```text -(Confirmation or status from the farmer RPC client; connection errors appear if the farmer is not running.) +✓ Updated config with solver peer 192.0.2.10:8666 +✓ Connected to solver at 192.0.2.10:8666 ``` ```` +Other outcomes include `Solver address must be in format [IP:Port]`, `✗ Failed to update config: …`, `✗ Could not connect to farmer. Make sure farmer is running.`, or `✗ Failed to connect to solver: …`. + --- @@ -157,12 +171,27 @@ chia plotnft show -f 2121994410 Response: +Printed by [`pprint_pool_wallet_state`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/plotnft_funcs.py) / [`pprint_all_pool_wallet_state`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/plotnft_funcs.py). Example for a self-pooling wallet (addresses and ids vary): + ````mdx-code-block ```text -(Multi-line listing of plot NFT wallets, launcher ids, pool state, and URLs — format matches your wallet and plot NFT count.) +Wallet height: 4100123 +Sync status: Synced +Wallet ID: 3 +Current state: SELF_POOLING +Current state from block height: 3050000 +Launcher ID: 0x7f8e9d0c1b2a345678901234567890abcdef1234567890abcdef1234567890 +Target address (not for plotting): xch1jgfdw46k802z8e5ms70mywcahtwj7wur46x8z69uchpvgazmyjqsr92pf +Number of plots: 8 +Owner public key: 0xabcdef... +Pool contract address (use ONLY for plotting - do not send money to this address): xch1qpuzafwenx85x8stjslepmumcyu09t23zppgyq6wlsq5xtxw75xs00xewp +Claimable balance: 0.0 xch + ``` ```` +Pool-farming states add lines such as `Current pool URL:`, `Current difficulty:`, `Points balance:`, and payout lines from the same function. + ### `chia plotnft create` @@ -186,30 +215,26 @@ Options:
Example -Create a self-farming plot NFT: - ````mdx-code-block ```bash -chia plotnft create -s local -m 0.00005 -``` -```` - -Create and join a pool (example URL): - -````mdx-code-block -```bash -chia plotnft create -s pool -u https://pool.example.com -m 0.00005 +chia plotnft create -s local -m 0.00005 -y ``` ```` Response: +[`create`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/plotnft_funcs.py) prints intent, then on submission uses [`transaction_submitted_msg`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/cmds_util.py) and [`transaction_status_msg`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/cmds_util.py): + ````mdx-code-block ```text -(Transaction submission and confirmation prompts or summaries from the wallet — exact text depends on prompts and fees.) +Will create a plot NFT. +Transaction submitted to nodes: [{'peer_id': 'abcd1234…', 'inclusion_status': 'SUCCESS', 'error_msg': None}] +Run 'chia wallet get_transaction -f 2121994410 -tx 0xd4e5f6a7b8c9012345678901234567890abcdef1234567890abcdef1234567890' to get status ``` ```` +(`sent_to` entries mirror mempool submission status objects; exact JSON varies. Pool mode first prints pool headers from `create_pool_args` when fetching pool info.) +
### Other `chia plotnft` subcommands From 0a876cec90d83665ff9e4176bb31f380acee8ddd Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Fri, 8 May 2026 09:44:38 -0600 Subject: [PATCH 14/19] docs(cli): use source-derived show/netspace/peer/solver example responses Co-authored-by: Cursor --- .../cli-reference/full-node-cli.md | 49 +++++++++++++++++-- .../cli-reference/harvester-cli.md | 10 +++- .../cli-reference/solver-cli.md | 14 +++++- 3 files changed, 65 insertions(+), 8 deletions(-) diff --git a/docs/reference-client/cli-reference/full-node-cli.md b/docs/reference-client/cli-reference/full-node-cli.md index e35a72ce73..c665e75d5d 100644 --- a/docs/reference-client/cli-reference/full-node-cli.md +++ b/docs/reference-client/cli-reference/full-node-cli.md @@ -6,7 +6,7 @@ slug: /reference-client/cli-reference/full-node-cli Commands that talk to the full node use its RPC interface (default port 8555, `full_node.rpc_port` in `config.yaml`). HTTP JSON-RPC methods are listed on [Full Node RPC](/reference-client/rpc-reference/full-node-rpc). -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). +Sources: [`chia/cmds/show.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/show.py), [`chia/cmds/show_funcs.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/show_funcs.py), [`chia/cmds/netspace.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/netspace.py), [`chia/cmds/netspace_funcs.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/netspace_funcs.py), [`chia/cmds/peer.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/peer.py), [`chia/cmds/peer_funcs.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/peer_funcs.py). ## Reference @@ -43,12 +43,30 @@ chia show -f Response: +`-s` uses [`print_blockchain_state`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/show_funcs.py). Synced node excerpt (hashes and ports vary): + ````mdx-code-block ```text -(Current blockchain state or fee tables from the full node; format is multi-line text and JSON-like summaries from RPC responses.) +Network: mainnet Port: 8444 RPC Port: 8555 +Node ID: b4de30abc123… +Genesis Challenge: eeb0582… + +Current Blockchain Status: Full Node Synced + +Peak: Hash: 0xfb7891e9a4a9ca6f8a633e0632d82c2502f425526754f71aee5a55d6ad3933d8 + Time: Wed Jan 15 2025 12:00:00 UTC Height: 3339504 + +Estimated network space: 20.000 EiB +Current difficulty: 8192 +Current VDF sub_slot_iters: 135266304 + + Height: | Hash: + 3339504 | 0xfb7891e9a4a9ca6f8a633e0632d82c2502f425526754f71aee5a55d6ad3933d8 ``` ```` +`-f` prints JSON from [`get_fee_estimate`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/show_funcs.py) followed by formatted mempool / fee-rate tables (`Mempool max cost`, `Fee Rate Estimates:`, etc.). + :::note Legacy `chia show` connection flags @@ -85,12 +103,28 @@ chia netspace -d 192 Response: +Printed by [`netstorge_async`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/netspace_funcs.py); last line uses [`format_bytes`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/cmds_util.py) on `get_network_space`: + ````mdx-code-block ```text -(Estimated effective farm space over the chosen window, printed from the netspace helper.) +Older Block +Block Height: 3339312 +Weight: 9876543210 +VDF Iterations: 123456789012345 +Header Hash: 0xaa11bb22… + +Newer Block +Block Height: 3339504 +Weight: 9876654321 +VDF Iterations: 123456790012345 +Header Hash: 0xfb7891e9… + +18.500 EiB ``` ```` +If the peak is missing you may see `No blocks in blockchain`. + --- @@ -125,12 +159,19 @@ chia peer full_node -a 203.0.113.5:8444 Response: +`-c` lists connections via [`print_connections`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/peer_funcs.py): + ````mdx-code-block ```text -(List of peers or confirmation after add/remove; errors surface TLS or connectivity problems.) +Connections: +Type IP Ports NodeID Last Connect MiB Up|Dwn +FULL_NODE 203.0.113.5 8444/8444 a1b2c3d4... Jan 15 12:00:01 1.2| 99.3 + -Height: 3339504 -Hash: fb7891e9... ``` ```` +`-a` prints `Connecting to 203.0.113.5, 8444` then any RPC error string from `open_connection`. + Other `chia peer ` targets (`farmer`, `wallet`, `harvester`, `data_layer`, `simulator`, `solver`, …) use the same option shape with that service’s RPC port — see [Farmer CLI](/reference-client/cli-reference/farmer-cli), [Harvester CLI](/reference-client/cli-reference/harvester-cli), and related pages. diff --git a/docs/reference-client/cli-reference/harvester-cli.md b/docs/reference-client/cli-reference/harvester-cli.md index 71ddc45953..d856d97a5e 100644 --- a/docs/reference-client/cli-reference/harvester-cli.md +++ b/docs/reference-client/cli-reference/harvester-cli.md @@ -8,7 +8,7 @@ There is no top-level `chia harvester` command group. Start the harvester with ` HTTP JSON-RPC methods and payloads are documented on [Harvester RPC](/reference-client/rpc-reference/harvester-rpc). Use `chia rpc harvester ''` the same way as other services (see [RPC overview](/reference-client/rpc-reference/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). +Sources: [`chia/cmds/peer.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/peer.py), [`chia/cmds/peer_funcs.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/peer_funcs.py), [`chia/cmds/plots.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/plots.py). ## Reference @@ -39,12 +39,18 @@ chia peer harvester -c Response: +Same [`print_connections`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/peer_funcs.py) formatting as `chia peer full_node -c`, but peers reflect harvester connections (often fewer rows): + ````mdx-code-block ```text -(List of peers reported by the harvester RPC; empty if only local farming.) +Connections: +Type IP Ports NodeID Last Connect MiB Up|Dwn +FARMER 127.0.0.1 8447/8448 f3e4d5c6... Jan 15 12:00:01 0.1| 2.4 ``` ```` +If there are no peers, you still get the two header lines plus no connection rows. + --- diff --git a/docs/reference-client/cli-reference/solver-cli.md b/docs/reference-client/cli-reference/solver-cli.md index 0f68e88bf1..b53162e6d1 100644 --- a/docs/reference-client/cli-reference/solver-cli.md +++ b/docs/reference-client/cli-reference/solver-cli.md @@ -6,7 +6,7 @@ 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`). HTTP endpoints are documented on [Solver RPC](/reference-client/rpc-reference/solver-rpc). From the shell, call `chia rpc solver ''` like other services (see [RPC overview](/reference-client/rpc-reference/rpc)). -Sources: [`chia/cmds/solver.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/solver.py). +Sources: [`chia/cmds/solver.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/solver.py), [`chia/cmds/solver_funcs.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/solver_funcs.py), [`chia/solver/solver_rpc_api.py`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/solver/solver_rpc_api.py). ## Reference @@ -35,12 +35,18 @@ chia solver get_state -sp 8667 Response: +[`get_state`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/solver_funcs.py) prints `json.dumps(..., indent=2)` from the RPC client. Payload matches [`SolverRpcApi.get_state`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/solver/solver_rpc_api.py): + ````mdx-code-block ```text -(JSON-style solver status when the service is running; if the solver is stopped you get a connection error naming the host and port.) +{ + "started": true +} ``` ```` +On failure the same function prints `Failed to get solver state: …` with the exception message (for example TLS connection errors). +
@@ -56,6 +62,8 @@ chia rpc solver get_state '{}' Response: +HTTP JSON body matches the solver RPC handler (same keys as above): + ````mdx-code-block ```json { @@ -64,6 +72,8 @@ Response: ``` ```` +(Service JSON matches [`SolverRpcApi.get_state`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/solver/solver_rpc_api.py); the `chia rpc` CLI may add transport metadata depending on version.) + When TLS services are down, the client prints a connection error instead of JSON.
From f3e4e4fcaccd1024deeb684fabf53f50de7caf45 Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Fri, 8 May 2026 09:44:39 -0600 Subject: [PATCH 15/19] docs(cli): use source-derived plotnft and db hub example responses Co-authored-by: Cursor --- docs/reference-client/cli-reference/cli.md | 52 ++++++++++++++++++++-- 1 file changed, 48 insertions(+), 4 deletions(-) diff --git a/docs/reference-client/cli-reference/cli.md b/docs/reference-client/cli-reference/cli.md index 0866467dcc..fba218decc 100644 --- a/docs/reference-client/cli-reference/cli.md +++ b/docs/reference-client/cli-reference/cli.md @@ -193,12 +193,27 @@ chia plotnft create -s local -m 0.00005 Response: +`show` output is produced by [`plotnft_funcs.show`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/plotnft_funcs.py) (wallet height, sync status, then per-wallet lines). Abbreviated: + ````mdx-code-block ```text -(Multi-line plot NFT status from `show`, or transaction output from `create` — see [Farmer CLI](/reference-client/cli-reference/farmer-cli#plot-nft) for the full option tables.) +Wallet height: 4100123 +Sync status: Synced +Wallet ID: 3 +Current state: SELF_POOLING +Current state from block height: 3050000 +Launcher ID: 0x7f8e9d0c1b2a345678901234567890abcdef1234567890abcdef1234567890 +Target address (not for plotting): xch1jgfdw46k802z8e5ms70mywcahtwj7wur46x8z69uchpvgazmyjqsr92pf +Number of plots: 8 +Owner public key: 0xabcdef01... +Pool contract address (use ONLY for plotting - do not send money to this address): xch1qpuzafwenx85x8stjslepmumcyu09t23zppgyq6wlsq5xtxw75xs00xewp +Claimable balance: 0.0 xch + ``` ```` +`create` prints `Will create a plot NFT…` and then [`transaction_submitted_msg`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/cmds_util.py) / [`transaction_status_msg`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/cmds_util.py) when the transaction is submitted (see [Farmer CLI](/reference-client/cli-reference/farmer-cli#plot-nft)). + ## plots {#plots} @@ -248,12 +263,24 @@ chia db upgrade --input ~/.chia/mainnet/db/blockchain_v1_mainnet.sqlite --output Response: +[`convert_v1_to_v2`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/db_upgrade_func.py) prints progress lines; when `config.yaml` is updated, [`db_upgrade_func`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/db_upgrade_func.py) also prints: + ````mdx-code-block ```text -(Progress and completion messages from the upgrade tool; failures print FAILED: … with a reason.) +-- Opening file for reading: /home/user/.chia/mainnet/db/blockchain_v1_mainnet.sqlite +-- Opening file for writing: /home/user/.chia/mainnet/db/blockchain_v2_mainnet.sqlite +-- Initializing v2 version +-- Peak: … Height: … +-- DB v1 to v2 conversion started +-- [1/4] Converting full_blocks +… +updating config.yaml +database_path: db/blockchain_v2_CHALLENGE.sqlite ``` ```` +On failure, messages include `conversion failed with error:` or `LEAVING PREVIOUS DB FILE UNTOUCHED` (see source). + ### backup {#backup} @@ -291,9 +318,15 @@ chia db backup --backup_file ~/chia-db-backup.sqlite Response: +[`db_backup_func`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/db_backup_func.py) / [`backup_db`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/db_backup_func.py): + ````mdx-code-block ```text -(Status lines from the vacuum/backup step; long runs may take hours on large databases.) +reading from blockchain database: /home/user/.chia/mainnet/db/blockchain_v2_mainnet.sqlite +writing to backup file: /home/user/.chia/mainnet/db/vacuumed_blockchain_v2_mainnet.sqlite + + +Database backup finished : /home/user/.chia/mainnet/db/vacuumed_blockchain_v2_mainnet.sqlite ``` ```` @@ -333,12 +366,23 @@ chia db validate --validate-blocks Response: +[`db_validate_func`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/db_validate_func.py) / [`validate_v2`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/db_validate_func.py) print opening paths, peak, traversal progress, then: + ````mdx-code-block ```text -(Validation progress from tip toward genesis; failures print FAILED: … .) +opening file for reading: /home/user/.chia/mainnet/db/blockchain_v2_mainnet.sqlite +peak hash: fb7891e9a4a9ca6f8a633e0632d82c2502f425526754f71aee5a55d6ad3933d8 +peak height: 3339504 +traversing the full chain +… + + +DATABASE IS VALID: /home/user/.chia/mainnet/db/blockchain_v2_mainnet.sqlite ``` ```` +(`peak hash` is printed with Python `bytes` repr; long runs emit intermediate progress.) + ## keys {#keys} From b5a280612031fe284fa248ebbfafc0d8c0943fb2 Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Fri, 8 May 2026 09:44:47 -0600 Subject: [PATCH 16/19] docs(cli): align transaction_submitted_msg sample with mempool status dict keys Co-authored-by: Cursor --- .../cli-reference/farmer-cli.md | 82 +++++++++---------- 1 file changed, 41 insertions(+), 41 deletions(-) diff --git a/docs/reference-client/cli-reference/farmer-cli.md b/docs/reference-client/cli-reference/farmer-cli.md index 60b8352656..df7b259f0d 100644 --- a/docs/reference-client/cli-reference/farmer-cli.md +++ b/docs/reference-client/cli-reference/farmer-cli.md @@ -18,14 +18,14 @@ Usage: `chia farm summary [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :----------------------- | :------ | :------- | :--------------------------------------------------------------------- | -| `-p` | `--rpc-port` | INTEGER | False | Full node RPC port (see `full_node.rpc_port` in `config.yaml`). | -| `-wp` | `--wallet-rpc-port` | INTEGER | False | Wallet RPC port (see `wallet.rpc_port`). | -| `-hp` | `--harvester-rpc-port` | INTEGER | False | Harvester RPC port for the local harvester (see `harvester.rpc_port`). | -| `-fp` | `--farmer-rpc-port` | INTEGER | False | Farmer RPC port (see `farmer.rpc_port`). | -| `-i` | `--include-pool-rewards` | None | False | Include pool farming rewards in displayed totals. | -| `-h` | `--help` | None | False | Show a help message and exit. | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :--------------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------- | +| `-p` | `--rpc-port` | INTEGER | False | Full node RPC port (see `full_node.rpc_port` in `config.yaml`). | +| `-wp` | `--wallet-rpc-port` | INTEGER | False | Wallet RPC port (see `wallet.rpc_port`). | +| `-hp` | `--harvester-rpc-port` | INTEGER | False | Harvester RPC port for the local harvester (see `harvester.rpc_port`). | +| `-fp` | `--farmer-rpc-port` | INTEGER | False | Farmer RPC port (see `farmer.rpc_port`). | +| `-i` | `--include-pool-rewards` | None | False | Include pool farming rewards in displayed totals. | +| `-h` | `--help` | None | False | Show a help message and exit. |
Example @@ -72,11 +72,11 @@ Usage: `chia farm challenges [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------ | :------ | :------- | :------------------------------------------------------------- | -| `-fp` | `--farmer-rpc-port` | INTEGER | False | Farmer RPC port. | -| `-l` | `--limit` | INTEGER | False | Max challenges to print; `0` disables the limit [default: 20]. | -| `-h` | `--help` | None | False | Show a help message and exit. | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------ | :------ | :------- | :-------------------------------------------------------------------------- | +| `-fp` | `--farmer-rpc-port` | INTEGER | False | Farmer RPC port. | +| `-l` | `--limit` | INTEGER | False | Max challenges to print; `0` disables the limit [default: 20]. | +| `-h` | `--help` | None | False | Show a help message and exit. |
Example @@ -110,10 +110,10 @@ Usage: `chia farm connect-solver [OPTIONS] SOLVER_ADDRESS` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------ | :------ | :------- | :---------------------------- | -| `-fp` | `--farmer-rpc-port` | INTEGER | False | Farmer RPC port. | -| `-h` | `--help` | None | False | Show a help message and exit. | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------ | :------ | :------- | :------------------------------ | +| `-fp` | `--farmer-rpc-port` | INTEGER | False | Farmer RPC port. | +| `-h` | `--help` | None | False | Show a help message and exit. |
Example @@ -153,12 +153,12 @@ Usage: `chia plotnft show [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------ | :------ | :------- | :-------------------------------------------------------- | -| `-f` | `--fingerprint` | INTEGER | False | Fingerprint of the wallet to use. | -| `-wp` | `--wallet-rpc_port` | INTEGER | False | Wallet RPC port (see `wallet.rpc_port` in `config.yaml`). | -| `-i` | `--id` | INTEGER | False | Wallet id to use. | -| `-h` | `--help` | None | False | Show a help message and exit. | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :----------------- | :------ | :------- | :------------------------------------------------------------------------------------------------ | +| `-f` | `--fingerprint` | INTEGER | False | Fingerprint of the wallet to use. | +| `-wp` | `--wallet-rpc_port`| INTEGER | False | Wallet RPC port (see `wallet.rpc_port` in `config.yaml`). | +| `-i` | `--id` | INTEGER | False | Wallet id to use. | +| `-h` | `--help` | None | False | Show a help message and exit. |
Example @@ -202,15 +202,15 @@ Usage: `chia plotnft create [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------ | :------ | :------- | :--------------------------------------------------------------------------------- | -| `-f` | `--fingerprint` | INTEGER | False | Fingerprint of the wallet to use. | -| `-wp` | `--wallet-rpc_port` | INTEGER | False | Wallet RPC port. | -| `-s` | `--state` | CHOICE | True | `local` (self-farming) or `pool` (see `chia plotnft create -h`). | -| `-u` | `--pool-url` | TEXT | False | HTTPS host:port of the pool; required when `--state` is `pool`. | -| `-m` | `--fee` | XCH | True | Fee per transaction in XCH (used twice: singleton creation and init) [default: 0]. | -| `-y` | `--yes` | None | False | No prompts. | -| `-h` | `--help` | None | False | Show a help message and exit. | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :----------------- | :---------- | :------- | :-------------------------------------------------------------------------------------------- | +| `-f` | `--fingerprint` | INTEGER | False | Fingerprint of the wallet to use. | +| `-wp` | `--wallet-rpc_port`| INTEGER | False | Wallet RPC port. | +| `-s` | `--state` | CHOICE | True | `local` (self-farming) or `pool` (see `chia plotnft create -h`). | +| `-u` | `--pool-url` | TEXT | False | HTTPS host:port of the pool; required when `--state` is `pool`. | +| `-m` | `--fee` | XCH | True | Fee per transaction in XCH (used twice: singleton creation and init) [default: 0]. | +| `-y` | `--yes` | None | False | No prompts. | +| `-h` | `--help` | None | False | Show a help message and exit. |
Example @@ -228,7 +228,7 @@ Response: ````mdx-code-block ```text Will create a plot NFT. -Transaction submitted to nodes: [{'peer_id': 'abcd1234…', 'inclusion_status': 'SUCCESS', 'error_msg': None}] +Transaction submitted to nodes: [{'peer_id': 'a1b2c3d4e5f6…', 'inclusion_status': 'SUCCESS', 'error_msg': None}] Run 'chia wallet get_transaction -f 2121994410 -tx 0xd4e5f6a7b8c9012345678901234567890abcdef1234567890abcdef1234567890' to get status ``` ```` @@ -239,14 +239,14 @@ Run 'chia wallet get_transaction -f 2121994410 -tx 0xd4e5f6a7b8c9012345678901234 ### Other `chia plotnft` subcommands -| Command | Purpose | -| :--------------------------- | :--------------------------------------------------------- | -| `join` | Join a plot NFT to a pool (`-u` pool URL required). | -| `leave` | Leave a pool and return to self-farming. | -| `claim` | Claim pool rewards. | -| `inspect` | Detailed plot NFT JSON (wallet options `-f`, `-wp`, `-i`). | -| `get_login_link` | Pool login link (`-l` / `--launcher_id` required). | -| `change_payout_instructions` | Update payout address (`-l` launcher id, `-a` address). | +| Command | Purpose | +| :--------------------------- | :---------------------------------------------------------------------------- | +| `join` | Join a plot NFT to a pool (`-u` pool URL required). | +| `leave` | Leave a pool and return to self-farming. | +| `claim` | Claim pool rewards. | +| `inspect` | Detailed plot NFT JSON (wallet options `-f`, `-wp`, `-i`). | +| `get_login_link` | Pool login link (`-l` / `--launcher_id` required). | +| `change_payout_instructions` | Update payout address (`-l` launcher id, `-a` address). | Run `chia plotnft -h` for the full option table of each subcommand. From 4cfe7bb70c8f2c402944b1bc0f92ac799a253e4e Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Fri, 8 May 2026 14:47:32 -0600 Subject: [PATCH 17/19] style: prettier farmer-cli.md Co-authored-by: Cursor --- .../cli-reference/farmer-cli.md | 80 +++++++++---------- 1 file changed, 40 insertions(+), 40 deletions(-) diff --git a/docs/reference-client/cli-reference/farmer-cli.md b/docs/reference-client/cli-reference/farmer-cli.md index df7b259f0d..88ac9ec40b 100644 --- a/docs/reference-client/cli-reference/farmer-cli.md +++ b/docs/reference-client/cli-reference/farmer-cli.md @@ -18,14 +18,14 @@ Usage: `chia farm summary [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :--------------------- | :------ | :------- | :-------------------------------------------------------------------------------------------------------- | -| `-p` | `--rpc-port` | INTEGER | False | Full node RPC port (see `full_node.rpc_port` in `config.yaml`). | -| `-wp` | `--wallet-rpc-port` | INTEGER | False | Wallet RPC port (see `wallet.rpc_port`). | -| `-hp` | `--harvester-rpc-port` | INTEGER | False | Harvester RPC port for the local harvester (see `harvester.rpc_port`). | -| `-fp` | `--farmer-rpc-port` | INTEGER | False | Farmer RPC port (see `farmer.rpc_port`). | -| `-i` | `--include-pool-rewards` | None | False | Include pool farming rewards in displayed totals. | -| `-h` | `--help` | None | False | Show a help message and exit. | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :----------------------- | :------ | :------- | :--------------------------------------------------------------------- | +| `-p` | `--rpc-port` | INTEGER | False | Full node RPC port (see `full_node.rpc_port` in `config.yaml`). | +| `-wp` | `--wallet-rpc-port` | INTEGER | False | Wallet RPC port (see `wallet.rpc_port`). | +| `-hp` | `--harvester-rpc-port` | INTEGER | False | Harvester RPC port for the local harvester (see `harvester.rpc_port`). | +| `-fp` | `--farmer-rpc-port` | INTEGER | False | Farmer RPC port (see `farmer.rpc_port`). | +| `-i` | `--include-pool-rewards` | None | False | Include pool farming rewards in displayed totals. | +| `-h` | `--help` | None | False | Show a help message and exit. |
Example @@ -72,11 +72,11 @@ Usage: `chia farm challenges [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------ | :------ | :------- | :-------------------------------------------------------------------------- | -| `-fp` | `--farmer-rpc-port` | INTEGER | False | Farmer RPC port. | -| `-l` | `--limit` | INTEGER | False | Max challenges to print; `0` disables the limit [default: 20]. | -| `-h` | `--help` | None | False | Show a help message and exit. | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------ | :------ | :------- | :------------------------------------------------------------- | +| `-fp` | `--farmer-rpc-port` | INTEGER | False | Farmer RPC port. | +| `-l` | `--limit` | INTEGER | False | Max challenges to print; `0` disables the limit [default: 20]. | +| `-h` | `--help` | None | False | Show a help message and exit. |
Example @@ -110,10 +110,10 @@ Usage: `chia farm connect-solver [OPTIONS] SOLVER_ADDRESS` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------ | :------ | :------- | :------------------------------ | -| `-fp` | `--farmer-rpc-port` | INTEGER | False | Farmer RPC port. | -| `-h` | `--help` | None | False | Show a help message and exit. | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------ | :------ | :------- | :---------------------------- | +| `-fp` | `--farmer-rpc-port` | INTEGER | False | Farmer RPC port. | +| `-h` | `--help` | None | False | Show a help message and exit. |
Example @@ -153,12 +153,12 @@ Usage: `chia plotnft show [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :----------------- | :------ | :------- | :------------------------------------------------------------------------------------------------ | -| `-f` | `--fingerprint` | INTEGER | False | Fingerprint of the wallet to use. | -| `-wp` | `--wallet-rpc_port`| INTEGER | False | Wallet RPC port (see `wallet.rpc_port` in `config.yaml`). | -| `-i` | `--id` | INTEGER | False | Wallet id to use. | -| `-h` | `--help` | None | False | Show a help message and exit. | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------ | :------ | :------- | :-------------------------------------------------------- | +| `-f` | `--fingerprint` | INTEGER | False | Fingerprint of the wallet to use. | +| `-wp` | `--wallet-rpc_port` | INTEGER | False | Wallet RPC port (see `wallet.rpc_port` in `config.yaml`). | +| `-i` | `--id` | INTEGER | False | Wallet id to use. | +| `-h` | `--help` | None | False | Show a help message and exit. |
Example @@ -202,15 +202,15 @@ Usage: `chia plotnft create [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :----------------- | :---------- | :------- | :-------------------------------------------------------------------------------------------- | -| `-f` | `--fingerprint` | INTEGER | False | Fingerprint of the wallet to use. | -| `-wp` | `--wallet-rpc_port`| INTEGER | False | Wallet RPC port. | -| `-s` | `--state` | CHOICE | True | `local` (self-farming) or `pool` (see `chia plotnft create -h`). | -| `-u` | `--pool-url` | TEXT | False | HTTPS host:port of the pool; required when `--state` is `pool`. | -| `-m` | `--fee` | XCH | True | Fee per transaction in XCH (used twice: singleton creation and init) [default: 0]. | -| `-y` | `--yes` | None | False | No prompts. | -| `-h` | `--help` | None | False | Show a help message and exit. | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------ | :------ | :------- | :--------------------------------------------------------------------------------- | +| `-f` | `--fingerprint` | INTEGER | False | Fingerprint of the wallet to use. | +| `-wp` | `--wallet-rpc_port` | INTEGER | False | Wallet RPC port. | +| `-s` | `--state` | CHOICE | True | `local` (self-farming) or `pool` (see `chia plotnft create -h`). | +| `-u` | `--pool-url` | TEXT | False | HTTPS host:port of the pool; required when `--state` is `pool`. | +| `-m` | `--fee` | XCH | True | Fee per transaction in XCH (used twice: singleton creation and init) [default: 0]. | +| `-y` | `--yes` | None | False | No prompts. | +| `-h` | `--help` | None | False | Show a help message and exit. |
Example @@ -239,14 +239,14 @@ Run 'chia wallet get_transaction -f 2121994410 -tx 0xd4e5f6a7b8c9012345678901234 ### Other `chia plotnft` subcommands -| Command | Purpose | -| :--------------------------- | :---------------------------------------------------------------------------- | -| `join` | Join a plot NFT to a pool (`-u` pool URL required). | -| `leave` | Leave a pool and return to self-farming. | -| `claim` | Claim pool rewards. | -| `inspect` | Detailed plot NFT JSON (wallet options `-f`, `-wp`, `-i`). | -| `get_login_link` | Pool login link (`-l` / `--launcher_id` required). | -| `change_payout_instructions` | Update payout address (`-l` launcher id, `-a` address). | +| Command | Purpose | +| :--------------------------- | :--------------------------------------------------------- | +| `join` | Join a plot NFT to a pool (`-u` pool URL required). | +| `leave` | Leave a pool and return to self-farming. | +| `claim` | Claim pool rewards. | +| `inspect` | Detailed plot NFT JSON (wallet options `-f`, `-wp`, `-i`). | +| `get_login_link` | Pool login link (`-l` / `--launcher_id` required). | +| `change_payout_instructions` | Update payout address (`-l` launcher id, `-a` address). | Run `chia plotnft -h` for the full option table of each subcommand. From 3f036eb0e7441e8454f5ff0c5db2b973163b0c0c Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Wed, 12 Aug 2026 09:06:07 -0600 Subject: [PATCH 18/19] docs(cli): fix farm challenges sample and clarify connect-solver host:port Align the challenges Response with one challenge hash and ten signage-point indices, and note that connect-solver takes host:port rather than a node ID. Co-authored-by: Cursor --- .../cli-reference/farmer-cli.md | 28 ++++++++++++------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/docs/reference-client/cli-reference/farmer-cli.md b/docs/reference-client/cli-reference/farmer-cli.md index 88ac9ec40b..1327c02800 100644 --- a/docs/reference-client/cli-reference/farmer-cli.md +++ b/docs/reference-client/cli-reference/farmer-cli.md @@ -66,17 +66,17 @@ Other branches print different first lines for `Farming status:` (`Not available ## `chia farm challenges` -Functionality: Print recent signage-point challenges from the farmer. +Functionality: Print recent signage points from the farmer. Each line is one signage point: `Hash` is the challenge hash, and `Index` is that challenge's signage-point index (`0` to `63`). Do not treat consecutive lines with the same hash as different challenges. Usage: `chia farm challenges [OPTIONS]` Options: -| Short Command | Long Command | Type | Required | Description | -| :------------ | :------------------ | :------ | :------- | :------------------------------------------------------------- | -| `-fp` | `--farmer-rpc-port` | INTEGER | False | Farmer RPC port. | -| `-l` | `--limit` | INTEGER | False | Max challenges to print; `0` disables the limit [default: 20]. | -| `-h` | `--help` | None | False | Show a help message and exit. | +| Short Command | Long Command | Type | Required | Description | +| :------------ | :------------------ | :------ | :------- | :-------------------------------------------------------------------------------- | +| `-fp` | `--farmer-rpc-port` | INTEGER | False | Farmer RPC port. | +| `-l` | `--limit` | INTEGER | False | Limit the number of challenges shown. Use `0` to disable the limit [default: 20]. | +| `-h` | `--help` | None | False | Show a help message and exit. |
Example @@ -89,12 +89,20 @@ chia farm challenges -l 10 Response: -Each line is formatted in [`challenges`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/farm_funcs.py): +[`challenges`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/farm_funcs.py) prints the newest signage points first (newest `limit` rows when `-l` is set). Within one challenge the hash repeats while the index changes: ````mdx-code-block ```text -Hash: 0xa1b2c3d4e5f6789012345678901234567890abcd1234567890abcd1234567890 Index: 42 -Hash: 0xb2c3d4e5f6789012345678901234567890abcd1234567890abcd1234567890ab Index: 43 +Hash: 0xa1b2c3d4e5f6789012345678901234567890abcd1234567890abcd1234567890 Index: 63 +Hash: 0xa1b2c3d4e5f6789012345678901234567890abcd1234567890abcd1234567890 Index: 62 +Hash: 0xa1b2c3d4e5f6789012345678901234567890abcd1234567890abcd1234567890 Index: 61 +Hash: 0xa1b2c3d4e5f6789012345678901234567890abcd1234567890abcd1234567890 Index: 60 +Hash: 0xa1b2c3d4e5f6789012345678901234567890abcd1234567890abcd1234567890 Index: 59 +Hash: 0xa1b2c3d4e5f6789012345678901234567890abcd1234567890abcd1234567890 Index: 58 +Hash: 0xa1b2c3d4e5f6789012345678901234567890abcd1234567890abcd1234567890 Index: 57 +Hash: 0xa1b2c3d4e5f6789012345678901234567890abcd1234567890abcd1234567890 Index: 56 +Hash: 0xa1b2c3d4e5f6789012345678901234567890abcd1234567890abcd1234567890 Index: 55 +Hash: 0xa1b2c3d4e5f6789012345678901234567890abcd1234567890abcd1234567890 Index: 54 ``` ```` @@ -104,7 +112,7 @@ Hash: 0xb2c3d4e5f6789012345678901234567890abcd1234567890abcd1234567890ab Index: ## `chia farm connect-solver` {#chia-farm-connect-solver} -Functionality: Point the farmer at a Solver service (`host:port`). The same integration is available over farmer RPC as `connect_to_solver` on [Farmer RPC](/reference-client/rpc-reference/farmer-rpc). See also [Solver CLI](/reference-client/cli-reference/solver-cli). +Functionality: Point the farmer at a Solver service using `host:port` (hostname or IP plus port). Node IDs are not accepted; [`solver_connect`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/farm_funcs.py) parses the argument with `parse_host_port`. The same integration is available over farmer RPC as `connect_to_solver` on [Farmer RPC](/reference-client/rpc-reference/farmer-rpc). See also [Solver CLI](/reference-client/cli-reference/solver-cli). Usage: `chia farm connect-solver [OPTIONS] SOLVER_ADDRESS` From 0c22009e541ac34fada6dcdee1dc70975e4282af Mon Sep 17 00:00:00 2001 From: ClydeWallace22 <48610606+BrandtH22@users.noreply.github.com> Date: Wed, 12 Aug 2026 09:06:15 -0600 Subject: [PATCH 19/19] docs(cli): preserve legacy plots-check anchor on CLI hub Keep hub fragment links working after plots check moved to plots-cli. Co-authored-by: Cursor --- docs/reference-client/cli-reference/cli.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/reference-client/cli-reference/cli.md b/docs/reference-client/cli-reference/cli.md index fba218decc..1f27797623 100644 --- a/docs/reference-client/cli-reference/cli.md +++ b/docs/reference-client/cli-reference/cli.md @@ -218,6 +218,10 @@ Claimable balance: 0.0 xch ## plots {#plots} + + + + The `chia plots` command group lists configured directories, adds or removes plot search paths, can run legacy `create`, and validates plots with `check`. Full option tables and `plots check` guidance are on [Plots CLI](/reference-client/cli-reference/plots-cli) (including [Plots check](/reference-client/cli-reference/plots-cli#plots-check)). For Bladebit, MadMax, and other external plotters, see [Plotters CLI](/reference-client/cli-reference/plotter-cli). ## db {#db}