aljaz/pear-docs
1
0
Fork 0
mirror of https://github.com/aljazceru/pear-docs.git synced 2025-12-17 14:34:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

Doc updates for Pear release 1.6.0 (#155)

Browse Source 
* 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`
This commit is contained in:
Sean Zellmer
2024-11-14 16:24:33 -06:00
committed by GitHub
parent 577c4c1bec
commit ac1349ee83
2 changed files with 19 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
reference/pear/api.md
View File

@@ -168,6 +168,16 @@ Root directory of project.
Directory for Pear runtime. Directory for Pear runtime.
### `Pear.config.dht.nodes <Array<Object>>`
A list of known [DHT](../../building-blocks/hyperdht.md) nodes of the form `{ host: <String>, port: <Number> }`. 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 <Array<Object>>`
A list of custom bootstrap nodes Pear is started with of the form `{ host: <String>, port: <Number> }`.
## `Pear.checkpoint(<Any>) => Promise` ## `Pear.checkpoint(<Any>) => Promise`
Stores state that will be available as `Pear.config.checkpoint` next time the application starts. Stores state that will be available as `Pear.config.checkpoint` next time the application starts.

13
reference/pear/cli.md
View File

@@ -158,6 +158,7 @@ Synchronize files from link to dir.
> To dump to stdout use `-` in place of `<dir>` > To dump to stdout use `-` in place of `<dir>`
``` ```
--dry-run|-d Execute a dump without writing
--checkout=n Dump from specified checkout, n is version length --checkout=n Dump from specified checkout, n is version length
--json Newline delimited JSON output --json Newline delimited JSON output
--force|-f Force overwrite existing files --force|-f Force overwrite existing files
@@ -187,10 +188,14 @@ This command instructs any existing sidecar process to shutdown
and then becomes the sidecar. and then becomes the sidecar.
``` ```
--verbose|-v Additional output --mem memory mode: RAM corestore
--mem memory mode: RAM corestore --log-level <level> Level to log at. 0,1,2,3 (OFF,ERR,INF,TRC)
--key=key Advanced. Switch release lines --log-labels <list> Labels to log (internal, always logged)
--help|-h Show help --log-fields <list> 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 <key> Advanced. Switch release lines
--help|-h Show help
``` ```
## `pear versions` ## `pear versions`