mirror of
https://github.com/aljazceru/pear-docs.git
synced 2025-12-17 14:34:19 +01:00
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`
This commit is contained in:
@@ -168,6 +168,16 @@ Root directory of project.
|
||||
|
||||
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`
|
||||
|
||||
Stores state that will be available as `Pear.config.checkpoint` next time the application starts.
|
||||
|
||||
@@ -158,6 +158,7 @@ Synchronize files from link to 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
|
||||
--json Newline delimited JSON output
|
||||
--force|-f Force overwrite existing files
|
||||
@@ -187,9 +188,13 @@ 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
|
||||
--log-level <level> Level to log at. 0,1,2,3 (OFF,ERR,INF,TRC)
|
||||
--log-labels <list> Labels to log (internal, always logged)
|
||||
--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
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user