From ac1349ee83e63531ab9b3f72919ddd8ebff7b5a9 Mon Sep 17 00:00:00 2001 From: Sean Zellmer Date: Thu, 14 Nov 2024 16:24:33 -0600 Subject: [PATCH] Doc updates for Pear release 1.6.0 (#155) * Add dump dry-run flag Added to pear with https://github.com/holepunchto/pear/pull/400/files * Add `pear sidecar` logging flags `-v` & `--sidecar` weren't added as they aren't used. * Add `Pear.config.dht.nodes` & `Pear.config.dht.bootstrap` --- reference/pear/api.md | 10 ++++++++++ reference/pear/cli.md | 13 +++++++++---- 2 files changed, 19 insertions(+), 4 deletions(-) diff --git a/reference/pear/api.md b/reference/pear/api.md index b8163a1..e0dda82 100644 --- a/reference/pear/api.md +++ b/reference/pear/api.md @@ -168,6 +168,16 @@ Root directory of project. Directory for Pear runtime. +### `Pear.config.dht.nodes >` + +A list of known [DHT](../../building-blocks/hyperdht.md) nodes of the form `{ host: , port: }`. The nodes are set when the Pear application is started. + +Unless started with a custom set of bootstrap nodes, Pear caches known nodes to speed up connecting to the swarm and to make it more resilient. + +### `Pear.config.dht.bootstrap >` + +A list of custom bootstrap nodes Pear is started with of the form `{ host: , port: }`. + ## `Pear.checkpoint() => Promise` Stores state that will be available as `Pear.config.checkpoint` next time the application starts. diff --git a/reference/pear/cli.md b/reference/pear/cli.md index 8d677ae..0311439 100644 --- a/reference/pear/cli.md +++ b/reference/pear/cli.md @@ -158,6 +158,7 @@ Synchronize files from link to dir. > To dump to stdout use `-` in place of `` ``` + --dry-run|-d Execute a dump without writing --checkout=n Dump from specified checkout, n is version length --json Newline delimited JSON output --force|-f Force overwrite existing files @@ -187,10 +188,14 @@ This command instructs any existing sidecar process to shutdown and then becomes the sidecar. ``` - --verbose|-v Additional output - --mem memory mode: RAM corestore - --key=key Advanced. Switch release lines - --help|-h Show help + --mem memory mode: RAM corestore + --log-level Level to log at. 0,1,2,3 (OFF,ERR,INF,TRC) + --log-labels Labels to log (internal, always logged) + --log-fields Show/hide: date,time,h:level,h:label,h:delta + --log-stacks Add a stack trace to each log message + --log Label:sidecar Level:2 Fields: h:level,h:label + --key Advanced. Switch release lines + --help|-h Show help ``` ## `pear versions`