Docs/cli overview top level index

docs/reference-client/cli-reference/farmer-cli.md

@@ -0,0 +1,118 @@
+---
+sidebar_label: Farmer
+title: Farmer CLI
+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).
+
+## `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. |
+
+<details>
+<summary>Example</summary>
+
+```bash
+chia farm summary
+chia farm summary -fp 8559 -p 8555
+```
+
+</details>
+
+### `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). |
+
+<details>
+<summary>Example</summary>
+
+```bash
+chia farm challenges -l 10
+```
+
+</details>
+
+### `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`). 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. |
+
+<details>
+<summary>Example</summary>
+
+```bash
+chia farm connect-solver 192.0.2.10:8666
+```
+
+</details>
+
+## Plot NFT {#plot-nft}
+
+Usage: `chia plotnft [OPTIONS] COMMAND`
+
+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`). |
+
+<details>
+<summary>Example: `plotnft show`</summary>
+
+```bash
+chia plotnft show
+```
+
+</details>
+
+<details>
+<summary>Example: create pool and self-farming plot NFTs</summary>
+
+```bash
+chia plotnft create -u https://pool.example.com
+chia plotnft create -s local
+```
+
+</details>
+
+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
+
+- [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)

docs/reference-client/cli-reference/full-node-cli.md

@@ -0,0 +1,91 @@
+---
+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, `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).
+
+## `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`).                                |
+
+<details>
+<summary>Example</summary>
+
+```bash
+chia show -s
+chia show --fee
+```
+
+</details>
+
+:::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).                                  |
+
+<details>
+<summary>Example</summary>
+
+```bash
+chia netspace -d 192
+```
+
+</details>
+
+## `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.        |
+
+<details>
+<summary>Example</summary>
+
+```bash
+chia peer full_node -c
+chia peer full_node -a 203.0.113.5:8444
+```
+
+</details>
+
+Other `chia peer <node_type>` targets (`farmer`, `wallet`, `harvester`, `data_layer`, `simulator`, `solver`) are documented on [Farmer CLI](/reference-client/cli-reference/farmer-cli), [Harvester CLI](/reference-client/cli-reference/harvester-cli), and related pages as applicable.
+
+## Related
+
+- [CLI overview](/reference-client/cli-reference/cli)
+- [RPC overview](/reference-client/rpc-reference/rpc)
+- [Full Node RPC](/reference-client/rpc-reference/full-node-rpc)

docs/reference-client/cli-reference/harvester-cli.md

@@ -0,0 +1,46 @@
+---
+sidebar_label: Harvester
+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`.
+
+HTTP JSON-RPC methods and payloads are documented on [Harvester RPC](/reference-client/rpc-reference/harvester-rpc). Use `chia rpc harvester <method> '<json>'` 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 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. |
+
+<details>
+<summary>Example</summary>
+
+```bash
+chia peer harvester -c
+```
+
+</details>
+
+## 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`).
+
+## Remote harvester
+
+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)

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`
+
+<details>
+<summary>Example</summary>
+
+```bash
+chia plots show
+```
+
+</details>
+
+## `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 `.`). |
+
+<details>
+<summary>Example</summary>
+
+```bash
+chia plots add -d /mnt/chia/plots
+```
+
+</details>
+
+## `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 `.`). |
+
+<details>
+<summary>Example</summary>
+
+```bash
+chia plots remove -d /mnt/old-plots
+```
+
+</details>
+
+## `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. |
+
+<details>
+<summary>Example</summary>
+
+```bash
+chia plots create -k 32 -n 1 -t /tmp/chia -d /plots/final
+```
+
+</details>
+
+## 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.
+
+<details>
+<summary>Example</summary>
+
+```bash
+chia plots check -n 30 -g DriveA
+chia plots check -l -n 0
+```
+
+</details>
+
+### 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)