@offckb/cli 0.4.5-canary-8bcdc40.0 → 0.4.5-canary-eb2c329.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -276,8 +276,38 @@ offckb system-scripts --output <output-file-path>
276
276
 
277
277
  By default, OffCKB use a fixed Devnet config. You can customize it, for example by modifying the default log level (`warn,ckb-script=debug`).
278
278
 
279
- 1. Locate your Devnet config folder:
280
-
279
+ 1. Open the interactive Devnet config editor:
280
+
281
+ ```sh
282
+ offckb devnet config
283
+ ```
284
+
285
+ The editor uses a three-column layout: first-column file switcher (`ckb.toml` / `ckb-miner.toml`), a middle primary editing pane, and a smaller right read-only reference pane that shows the full built-in template for the currently selected file.
286
+
287
+ The left editing pane supports full key browsing/editing, including primitive value edits, object key add, array append/insert/move, search filter, and path delete.
288
+
289
+ Common shortcuts: `Enter` edit primitive, `a` add key/item, `i` insert array item, `m` move array item, `d` delete path, `/` search filter, `n`/`N` next/previous search match, `c` add custom value in fixed-array dialog (when allowed), `s` save, `q` quit.
290
+
291
+ Note: saving rewrites `ckb.toml` / `ckb-miner.toml` into canonical TOML format; upstream comments and original formatting are not preserved after save.
292
+
293
+ You can also update the same fields non-interactively (useful for scripts/CI):
294
+
295
+ ```sh
296
+ offckb devnet config --set ckb.logger.filter=info
297
+ offckb devnet config --set ckb.rpc.enable_deprecated_rpc=true --set miner.client.poll_interval=1500
298
+ ```
299
+
300
+ If your terminal is non-interactive (no TTY, e.g. CI/remote pipeline), use `--set` mode directly instead of the full-screen editor.
301
+
302
+ 1. Save changes and restart devnet:
303
+
304
+ ```sh
305
+ offckb clean -d
306
+ offckb node
307
+ ```
308
+
309
+ 1. (Advanced) Locate your Devnet config folder for manual edits:
310
+
281
311
  ```sh
282
312
  offckb config list
283
313
  ```
@@ -293,12 +323,12 @@ Example result:
293
323
  }
294
324
  }
295
325
  ```
326
+
296
327
  Pay attention to the `devnet.configPath` and `devnet.dataPath`.
297
-
298
- 2. `cd` into the `devnet.configPath` . Modify the config files as needed. See [Custom Devnet Setup](https://docs.nervos.org/docs/node/run-devnet-node#custom-devnet-setup) and [Configure CKB](https://github.com/nervosnetwork/ckb/blob/develop/docs/configure.md) for details.
299
- 3. After modifications, run `offckb clean -d` to remove the chain data if needed while keeping the updated config files.
300
- 4. Restart local blockchain by running `offckb node`
301
328
 
329
+ 1. `cd` into the `devnet.configPath` . Modify the config files as needed. See [Custom Devnet Setup](https://docs.nervos.org/docs/node/run-devnet-node#custom-devnet-setup) and [Configure CKB](https://github.com/nervosnetwork/ckb/blob/develop/docs/configure.md) for details.
330
+ 2. After modifications, run `offckb clean -d` to remove the chain data if needed while keeping the updated config files.
331
+ 3. Restart local blockchain by running `offckb node`
302
332
 
303
333
  ## Config Setting
304
334
 
Binary file