From a4a7e5bfc98232fe6cac3992ce56d1bc818b1b4e Mon Sep 17 00:00:00 2001 From: David Mark Clements Date: Thu, 7 Dec 2023 13:34:16 +0100 Subject: [PATCH] subdirs, cli --- README.md | 14 +- .../getting-started.md | 0 .../releasing-a-pear-app.md | 0 .../sharing-a-pear-app.md | 0 reference/api.md | 0 reference/cli.md | 126 ++++++++++++++++++ reference/configuration.md | 0 7 files changed, 133 insertions(+), 7 deletions(-) rename getting-started.md => guide/getting-started.md (100%) rename releasing-a-pear-app.md => guide/releasing-a-pear-app.md (100%) rename sharing-a-pear-app.md => guide/sharing-a-pear-app.md (100%) create mode 100644 reference/api.md create mode 100644 reference/cli.md create mode 100644 reference/configuration.md diff --git a/README.md b/README.md index f5c5968..82bfee8 100644 --- a/README.md +++ b/README.md @@ -15,13 +15,13 @@ Welcome to the Internet of Peers ### Guide -* [Getting Started](./getting-started.md) -* [Making a Pear App](./making-a-pear-app.md) -* [Sharing a Pear App](./sharing-a-pear-app.md) -* [Releasing a Pear App](./releasing-a-pear-app.md) +* [Getting Started](./guide/getting-started.md) +* [Making a Pear App](./guide/making-a-pear-app.md) +* [Sharing a Pear App](./guide/sharing-a-pear-app.md) +* [Releasing a Pear App](./guide/releasing-a-pear-app.md) ### Reference -* [Application Configuration](./configuration.md) -* [Command-Line-Interface (CLI)](./cli.md) -* [Application-Programming-Interface (API)](./api.md) +* [Application Configuration](./reference/configuration.md) +* [Command-Line-Interface (CLI)](./reference/cli.md) +* [Application-Programming-Interface (API)](./reference/api.md) diff --git a/getting-started.md b/guide/getting-started.md similarity index 100% rename from getting-started.md rename to guide/getting-started.md diff --git a/releasing-a-pear-app.md b/guide/releasing-a-pear-app.md similarity index 100% rename from releasing-a-pear-app.md rename to guide/releasing-a-pear-app.md diff --git a/sharing-a-pear-app.md b/guide/sharing-a-pear-app.md similarity index 100% rename from sharing-a-pear-app.md rename to guide/sharing-a-pear-app.md diff --git a/reference/api.md b/reference/api.md new file mode 100644 index 0000000..e69de29 diff --git a/reference/cli.md b/reference/cli.md new file mode 100644 index 0000000..bc7b447 --- /dev/null +++ b/reference/cli.md @@ -0,0 +1,126 @@ +# Command Line Interface + +Pear's Command Line Interface (CLI) is the primary interface for Pear Development. + +## pear init [dir] + +Create initial project files. + +``` + --yes|-y Autoselect all defaults +``` + +## pear dev [dir] + +Start a project in development mode. + +Edit project files on disk. + +``` + --no-watch Disable watch-reload + --launch=key Launch an app in dev mode + --link=url Simulate deep-link click open + --store|-s=path Set the Application Storage path + --tmp-store|-t Use a temporary Application Storage path +``` +## pear stage [dir] + +Synchronize local changes to key. + +Channel name must be specified on first stage, +in order to generate the initial key. + +Outputs diff information and project key. + +``` + --json Newline delimited JSON output + --dry-run|-d Execute a stage without writing + --bare|-b File data only, no warmup optimization + --ignore Comma separated file path ignore list + --name Advanced. Override app name +``` + +## pear seed [dir] + +Seed project or reseed key. + +Specify channel or key to seed a project. + +Specify a remote key to reseed. + +``` + --json Newline delimited JSON output + --seeders|-s Additional public keys to seed from + --name Advanced. Override app name + --verbose|-v Additional output +``` + +## pear launch + +Launch an application. + +``` + --dev Launch the app in dev mode + --store|-s=path Set the Application Storage path + --tmp-store|-t Automatic new tmp folder as store path + --checkout=n|release|staged Launch a version +``` + +## pear release [dir] + +Set production release version. + +Set the release pointer against a version (default latest). + +Use this to indicate production release points. + +``` + --json Newline delimited JSON output + --checkout=n|current Set a custom release length (version) +``` + +## pear info + +Get metadata for a key. + +``` + --json Newline delimited JSON output +``` + +## pear dump + +Synchronize files from key to dir. + +``` + --json Newline delimited JSON output + --checkout=n Dump from a custom release length (version) +``` + +## pear sidecar + +The Pear Sidecar is a local-running HTTP and IPC server which +provides access to corestores. + +This command instructs any existing sidecar process to shutdown +and then becomes the sidecar. + +``` + --mem memory mode: RAM corestore + --attach-boot-io include initial sidecar I/O (if applicable) +``` + +## pear repl + +Connect to a Read-Eval-Print-Loop session with sidecar. + +A key is printed out, use with repl-swarm module to connect. + +## pear versions + +Output version information. + +``` +--json Single JSON object +``` + + diff --git a/reference/configuration.md b/reference/configuration.md new file mode 100644 index 0000000..e69de29