Skip to content

Commit 4705f13

Browse files
danieljperrydanieljperry
authored
Merge pull request #983 from Chia-Network/update-main-cli-page
Update main cli page
2 parents de699d9 + 7f02a2b commit 4705f13

1 file changed

Lines changed: 89 additions & 52 deletions

File tree

  • docs/reference-client/cli-reference

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

Lines changed: 89 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,20 @@ Some examples:
2525

2626
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.
2727

28+
## Related CLI references
29+
30+
This page is an overview. Deeper command documentation lives in topic pages, for example:
31+
32+
- [Wallet CLI](/reference-client/cli-reference/wallet-cli)
33+
- [Offers](/reference-client/cli-reference/offer-cli)
34+
- [Verifiable Credentials (VC)](/reference-client/cli-reference/vc-cli)
35+
- [Clawback](/reference-client/cli-reference/clawback-cli)
36+
- [Simulator](/reference-client/cli-reference/simulator-cli)
37+
- [Plotters](/reference-client/cli-reference/plotter-cli)
38+
- [DID](/reference-client/cli-reference/did-cli) and [NFT](/reference-client/cli-reference/nft-cli)
39+
- [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))
40+
- 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)
41+
2842
# Locate the `chia` binary executable
2943

3044
## Mac
@@ -49,19 +63,19 @@ Then, running the `chia -h` command should work.
4963

5064
There is more than one `chia.exe` binary; the GUI is `Chia.exe` (two of these!) and the CLI is `chia.exe`. They are found in different places. Note the big C versus the little c.
5165

52-
The CLI one is the one referred to in this document, and for version 2.1.0 installed for the user it can be found at
66+
The CLI is the one this document refers to. A typical per-user install layout (paths can vary by Chia version and install options) is:
5367

5468
```bash
5569
~\AppData\Local\Programs\Chia\resources\app.asar.unpacked\daemon\chia.exe
5670
```
5771

58-
If installed for all users it can be found at
72+
If installed for all users, a common location is:
5973

6074
```bash
6175
C:\Program Files\Chia\resources\app.asar.unpacked\daemon\chia.exe
6276
```
6377

64-
# [init](https://github.com/Chia-Network/chia-blockchain/blob/master/src/cmds/init.py)
78+
# [init](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/init.py)
6579

6680
Command: `chia init`
6781

@@ -81,35 +95,44 @@ If no old version exists, `init`:
8195

8296
# start
8397

84-
Command: `chia start {service}`
98+
Command: `chia start [OPTIONS] GROUP [GROUP ...]`
8599

86-
- Service `node` will start only the full node.
87-
- Service `farmer` will start the farmer, harvester, a full node, and the wallet.
88-
- positional arguments:
89-
\{all,node,harvester,farmer,farmer-no-wallet,farmer-only,timelord,timelord-only,timelord-launcher-only,wallet,wallet-only,introducer,simulator}
100+
Pass one or more **service group** names. The exact mapping is defined in the reference client as [`SERVICES_FOR_GROUP`](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/util/service_groups.py) in `chia/util/service_groups.py` (if this table and your install disagree, treat the source file and `chia start -h` as canonical).
90101

91102
**Flags**
92103

93104
`-r, --restart`: Restart of running processes
94105

95-
| | Full Node | Wallet | Farmer | Harvester | Timelord | Timelord Launcher | Timelord-Only | Introducer | Full Node Simulator |
96-
| ----------------- | --------- | ------ | ------ | --------- | -------- | ----------------- | ------------- | ---------- | ------------------- |
97-
| all | X | X | X | X | X | X | | | |
98-
| node | X | | | | | | | | |
99-
| harvester | | | | X | | | | | |
100-
| farmer | X | X | X | X | | | | | |
101-
| farmer-no-wallet | X | | X | X | | | | | |
102-
| farmer-only | | | X | | | | | | |
103-
| timelord | X | | | | X | X | | | |
104-
| timelord-only | | | | | X | | X | | |
105-
| timelord-launcher | | | | | | X | | | |
106-
| wallet | | X | | | | | | | |
107-
| introducer | | | | | | | | X | |
108-
| simulator | | | | | | | | | X |
106+
**Service groups** (internal service names in parentheses where helpful):
107+
108+
:::warning
109+
`chia start all` literally starts every service group, including timelord and timelord launcher. Only use `all` if this machine is intentionally configured to run timelord components.
110+
:::
111+
112+
| Group | What gets started |
113+
| ------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
114+
| `all` | Full node, wallet, farmer, harvester, timelord, timelord launcher, DataLayer (`chia_data_layer`, `chia_data_layer_http`) |
115+
| `daemon` | (no processes; reserved) |
116+
| `data` | Wallet, DataLayer (`chia_data_layer`) |
117+
| `data_layer_http` | DataLayer HTTP service only |
118+
| `node` | Full node only |
119+
| `harvester` | Harvester only |
120+
| `farmer` | Full node, wallet, farmer, harvester |
121+
| `farmer-no-wallet` | Full node, farmer, harvester (no wallet) |
122+
| `farmer-only` | Farmer service only |
123+
| `timelord` | Full node, timelord, timelord launcher |
124+
| `timelord-only` | Timelord only |
125+
| `timelord-launcher-only` | Timelord launcher only |
126+
| `wallet` | Wallet only |
127+
| `introducer` | Introducer |
128+
| `simulator` | Full node (simulator) |
129+
| `crawler` | Crawler |
130+
| `seeder` | Crawler and seeder |
131+
| `seeder-only` | Seeder only |
109132

110133
# plotters
111134

112-
In 2.1.0 the option to use different plotters including compressed plotter was introduced. Each plotter has slightly different hardware requirements and may need slightly different options specified.
135+
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.
113136
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).
114137

115138
## plotnft
@@ -139,7 +162,7 @@ To create a Plot NFT, use `chia plotnft create -u https://poolnamehere.com`, ent
139162
To switch pools, you can use `chia plotnft join`, and to leave a pool (switch to self farming), use `chia plotnft leave`.
140163
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.
141164

142-
## [Plots check](https://github.com/Chia-Network/chia-blockchain/blob/master/src/plotting/check_plots.py)
165+
## [Plots check](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/plotting/check_plots.py)
143166

144167
Command: `chia plots check -n [num checks] -l -g [substring]`
145168

@@ -172,7 +195,7 @@ Running the command with `-n 10` or `-n 20` is good for a very minor check, but
172195

173196
Consider using `-n 30` to get a statistically better idea.
174197

175-
For more detail, you can read about the DiskProver commands in [chiapos](https://github.com/Chia-Network/chiapos/blob/master/src/prover_disk.hpp)
198+
For more detail, you can read about the DiskProver commands in [chiapos](https://github.com/Chia-Network/chiapos/blob/main/src/prover_disk.hpp)
176199

177200
**What does the ratio of full proofs vs expected proofs mean?**
178201

@@ -242,7 +265,7 @@ Command: `chia db validate [add flags and parameters]`
242265

243266
# keys
244267

245-
## [derive](https://github.com/Chia-Network/chia-blockchain/blob/2f2593661c842b70a0e848752f12777f2df3ed18/chia/cmds/keys.py#L139)
268+
## [derive](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/keys.py)
246269

247270
Command: `chia keys derive [OPTIONS] COMMAND [ARGS]`
248271

@@ -259,7 +282,7 @@ Command: `chia keys derive [OPTIONS] COMMAND [ARGS]`
259282
- The valid values for `COMMAND` are `child-key`, `search`, and `wallet-address`.
260283
- See below for details and example commands.
261284

262-
### [child-key](https://github.com/Chia-Network/chia-blockchain/blob/2f2593661c842b70a0e848752f12777f2df3ed18/chia/cmds/keys.py#L271)
285+
### [child-key](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/keys.py)
263286

264287
Command: `chia keys derive child-key [OPTIONS]`
265288

@@ -289,7 +312,7 @@ Example HD path: m/12381n/8444n/2/
289312

290313
- Generate a mnemonic seed and show the farmer pubkeys 10-14 derived from that seed: `chia keys derive --mnemonic-seed-filename <(chia keys generate_and_print | sed -n 2p) child-key -i 10 -n 5 -t farmer`
291314

292-
### [search](https://github.com/Chia-Network/chia-blockchain/blob/2f2593661c842b70a0e848752f12777f2df3ed18/chia/cmds/keys.py#L162)
315+
### [search](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/keys.py)
293316

294317
Command: `chia keys derive search [OPTIONS] [SEARCH_TERMS]...`
295318

@@ -309,7 +332,7 @@ Command: `chia keys derive search [OPTIONS] [SEARCH_TERMS]...`
309332

310333
- Search for a wallet address: `chia keys derive search -t address -l 100 <xch address>`
311334

312-
### [wallet-address](https://github.com/Chia-Network/chia-blockchain/blob/2f2593661c842b70a0e848752f12777f2df3ed18/chia/cmds/keys.py#L234)
335+
### [wallet-address](https://github.com/Chia-Network/chia-blockchain/blob/main/chia/cmds/keys.py)
313336

314337
Command: `chia keys derive wallet-address [OPTIONS]`
315338

@@ -403,7 +426,21 @@ chia dev mempool benchmark -n 1000
403426

404427
---
405428

406-
# Other commands (not all are fully documented)
429+
## data (DataLayer)
430+
431+
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).
432+
433+
---
434+
435+
## solver
436+
437+
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.
438+
439+
---
440+
441+
## Other commands (not all are fully documented)
442+
443+
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.
407444

408445
```sh
409446
$ chia
@@ -418,28 +455,28 @@ Options:
418455
-h, --help Show this message and exit.
419456

420457
Commands:
421-
completion Generate shell completion
422-
configure Modify configuration
423-
dao Create, manage or show state of DAOs
424-
data Manage your data
425-
db Manage the blockchain database
426-
dev Developer commands and tools
427-
farm Manage your farm
428-
init Create or migrate the configuration
429-
keys Manage your keys
430-
netspace Estimate total farmed space on the network
431-
passphrase Manage your keyring passphrase
432-
peer Show, or modify peering connections
433-
plotnft Manage your plot NFTs
434-
plots Manage your plots
435-
plotters Advanced plotting options
436-
rpc RPC Client
437-
run_daemon Runs chia daemon
438-
show Show node information
439-
start Start service groups
440-
stop Stop services
441-
version Show chia version
442-
wallet Manage your wallet
458+
completion Generate shell completion
459+
configure Modify configuration
460+
data Manage your data (DataLayer)
461+
db Manage the blockchain database
462+
dev Developer commands and tools
463+
farm Manage your farm
464+
init Create or migrate the configuration
465+
keys Manage your keys
466+
netspace Estimate total farmed space on the network
467+
passphrase Manage your keyring passphrase
468+
peer Show, or modify peering connections
469+
plotnft Manage your plot NFTs
470+
plots Manage your plots
471+
plotters Advanced plotting options
472+
rpc RPC Client
473+
run_daemon Runs chia daemon
474+
show Show node information
475+
solver Manage your solver
476+
start Start service groups
477+
stop Stop services
478+
version Show chia version
479+
wallet Manage your wallet
443480

444481
```
445482

0 commit comments

Comments
 (0)