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

api docs, cli tweaks

Browse Source
This commit is contained in:
David Mark Clements
2023-12-07 15:42:02 +01:00
parent a4a7e5bfc9
commit 34f7980519
2 changed files with 964 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
reference/cli.md
View File

@@ -1,6 +1,6 @@
# Command Line Interface
# Command Line Interface (CLI)
Pear's Command Line Interface (CLI) is the primary interface for Pear Development.
The Command Line Interface is the primary interface for Pear Development.
## pear init [dir]
@@ -10,12 +10,19 @@ Create initial project files.
--yes|-y Autoselect all defaults
```
## pear dev [dir]
## pear dev [dir] -- [...args]
Start a project in development mode.
Edit project files on disk.
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`.
```
--no-watch Disable watch-reload
--launch=key Launch an app in dev mode
@@ -55,9 +62,15 @@ Specify a remote key to reseed.
--verbose|-v Additional output
```
## pear launch <key>
## pear launch <key|link> -- [...args]
Launch an application.
Launch an application by key or link.
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 Launch the app in dev mode