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

Pear release 1.11.1 docs (#169)

Browse Source 
* Add `data` cli command & info about `apps` subcommand

* Add `pear reset` cli command for resetting a Pear application

Added a warning in the description as the command can result in lost
data and users should be cautious when using it.

* Remove leading spaces for `data` command flags

* Add note about dumping paths from `pear://` links in `dump` command

* Add `Pear.tray()` to Pear API docs

* Add supported formats for tray icon

* Remove `--unsafe-clear-preferences` from `pear run` cli doc

* Add `pear.gui.name` config option

* Edit new documentation for grammar & formatting

* Clarify `pear.gui.name` is an override & doesnt have a default

* Remove using "you" in `pear dump` doc & Correct grammar in `Pear.tray()`

Co-authored-by: David Mark Clements <huperekchunow@googlemail.com>

* Reword `pear reset` to make warning explicit

* Add note about hidden app issues when linux doesn't support `Pear.tray()`

---------

Co-authored-by: David Mark Clements <huperekchunow@googlemail.com>
This commit is contained in:
Sean Zellmer
2025-03-07 12:54:57 -06:00
committed by GitHub
parent 835fd15cb6
commit 47c6f034cb
3 changed files with 70 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
reference/pear/cli.md
View File

@@ -91,7 +91,6 @@ Run an application from a link or dir.
--links <kvs> Override configured links with comma-separated key-values
--chrome-webrtc-internals Enable chrome://webrtc-internals
--unsafe-clear-app-storage Clear app storage
--unsafe-clear-preferences Clear preferences (such as trustlist)
--appling=path Set application shell path
--checkout=n Run a checkout, n is version length
--checkout=release Run checkout from marked released length
@@ -157,6 +156,12 @@ Synchronize files from link to dir.
> To dump to stdout use `-` in place of `<dir>`
`<link>` can contain a path portion to dump a subset of the files for the Pear application. For example, to dump only the `CHANGELOG.md` from Keet into a `dump-dir` directory run:
```
pear dump pear://keet/CHANGELOG.md dump-dir/
```
```
--dry-run|-d Execute a dump without writing
--checkout=n Dump from specified checkout, n is version length
@@ -218,6 +223,19 @@ Move user application storage between applications.
--json Newline delimited JSON output
```
## `pear reset [flags] <link>`
Advanced. Reset an application to initial state
Clears application storage for a given application link.
WARNING: Confirmation will be requested as the storage will be deleted permanently and cannot be recovered. Use with caution.
```
--json Newline delimited JSON output
--help|-h Show help
```
## `pear gc [flags] [command]`
Perform garbage collection and remove unused resources.
@@ -232,5 +250,27 @@ Perform garbage collection and remove unused resources.
--help|-h Show help
```
## `pear data [flags] [command]`
View database contents.
The database contains metadata stored on this device used by the Pear runtime.
| Commands | Description |
| ---------- | -------------------------- |
| apps | Installed apps |
| dht | DHT known-nodes cache |
| gc | Garbage collection records |
```
--secrets Show sensitive information, i.e. encryption-keys
--json Newline delimited JSON output
--help|-h Show help
```
### `pear data apps [flags] [link]`
List installed apps, filtered by `[link]` if provided.