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

align cli (#67)

Browse Source
This commit is contained in:
David Mark Clements
2024-02-21 20:56:37 +01:00
committed by GitHub
parent 347dc6d804
commit 8eb0391b78
1 changed files with 39 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
reference/cli.md
View File

@@ -8,27 +8,21 @@ Create initial project files.
``` ```
--yes|-y Autoselect all defaults --yes|-y Autoselect all defaults
--type|-t=type Project type: desktop (default) or terminal
--force|-f Force overwrite existing files
--with|-w=name Additional functionality. Available: node
``` ```
## pear dev [dir] -- [...args] ## pear dev [dir] [...args]
Start a project in development mode. Run a project in development mode from disk.
Edit project files on disk. Alias for: `pear run --dev <dir>`
Arguments supplied after a double-dash (`--`) are passed as `pear.config.args`.
Using `--link` instead of arguments allows for application invite links.
A Pear link takes the form: `pear://<key>/<data>`.
The `<data>` portion of the link is available as `pear.config.linkData`.
``` ```
--link=url Simulate deep-link click open --link=url Simulate deep-link click open
--run=key Run app from key in dev mode
--link=url Simulate deep-link click open
--store|-s=path Set the Application Storage path --store|-s=path Set the Application Storage path
--tmp-store|-t Use a temporary Application Storage path --tmp-store|-t Automatic new tmp folder as store path
``` ```
## pear stage <channel|key> [dir] ## pear stage <channel|key> [dir]
@@ -62,20 +56,20 @@ Specify a remote key to reseed.
--verbose|-v Additional output --verbose|-v Additional output
``` ```
## pear run <key> -- [...args] ## pear run <key|dir|alias> [...args]
Run an application from a key. Run an application from a key or dir.
The key argument may also be a a Pear Link containing the key. | | |
|-------|---------------------------------------------------|
| key | `pear://<key>` |
| dir | `file://<absolute-path>` \| `<absolute-path>` \| `<relative-path>` |
| alias | `pear://<alias>` |
A Pear Link takes the form: `pear://<key>/<data>`.
The `<data>` portion of the link is available as `pear.config.linkData`.
Arguments supplied after a double-dash (`--`) are passed as `pear.config.args`.
``` ```
--dev Run the app in dev mode --dev Run the app in dev mode
--link=url Simulate deep-link click open
--store|-s=path Set the Application Storage path --store|-s=path Set the Application Storage path
--tmp-store|-t Automatic new tmp folder as store path --tmp-store|-t Automatic new tmp folder as store path
--checkout=n Run a checkout, n is version length --checkout=n Run a checkout, n is version length
@@ -83,6 +77,21 @@ Arguments supplied after a double-dash (`--`) are passed as `pear.config.args`.
--checkout=staged Run checkout from latest version length --checkout=staged Run checkout from latest version length
``` ```
### Examples
```
pear run pear://u6c6it1hhb5serppr3tghdm96j1gprtesygejzhmhnk5xsse8kmy
```
```
pear run pear://keet
```
```
pear run file://path/to/an-app-folder
```
```
pear run path/to/an-app-folder --some args
```
## pear release <channel|key> [dir] ## pear release <channel|key> [dir]
Set production release version. Set production release version.
@@ -96,9 +105,13 @@ Use this to indicate production release points.
--checkout=n|current Set a custom release length (version) --checkout=n|current Set a custom release length (version)
``` ```
## pear info <key> ## pear info [key]
Get metadata for a key. Read project information.
Supply a key to view application info
Without a key pear info shows Pear info
``` ```
--json Newline delimited JSON output --json Newline delimited JSON output
@@ -132,10 +145,6 @@ Connect to a Read-Eval-Print-Loop session with sidecar.
A key is printed out, use with repl-swarm module to connect. A key is printed out, use with repl-swarm module to connect.
## pear use <key>
Switch to a different platform release-line.
## pear versions ## pear versions
Output version information. Output version information.