@swell/cli 0.1.0 → 1.0.0-alpha

package/README.md

@@ -1,6 +1,18 @@
 # @swell/cli
 
-We're in beta: commands and arguments can still change.
+#We're in beta: commands and arguments can still change.#
+
+Install with:
+
+```sh
+npm install -g @swell/cli
+```
+
+If you are using tools for version managing like [asdf](https://asdf-vm.com/), make sure you [reshim](https://asdf-vm.com/manage/core.html#reshim) after install:
+
+```sh
+asdf reshim
+```
 
 # Commands
 
@@ -12,15 +24,10 @@ Commands tend to support the following helper options:
 - --verbose (-v): Boolean, outputs all commands
 - --dry-run: Boolean, dry runs requests that delete data, but doesn't run them
 - --yes (-y): Boolean, answers all confirmation questions with **yes**.
-- --secret-key: String, Enables ephemeral secret-key based authentication for commands
-
-## Store namespaces
-
-All commands accept a `--store` or `-s` option, which allows switching the context of the CLI commands to the selected store. When not in use, all commands refer to the set default store.
 
 ## Login
 
-The `login` command authenticates and stores a user's session locally. Saved sessions can/will be used by other commands, unless a secret key is specified.
+The `admin login` command authenticates and stores a user's session locally. Saved sessions can/will be used by other commands, unless a secret key is specified.
 
 ```sh
 swell login [--username (-u) String] [--password (-p) String] [--set-default Boolean]
@@ -30,54 +37,33 @@ swell login [--username (-u) String] [--password (-p) String] [--set-default Boo
 
 ```sh
 swell login
-swell login --store test
-swell login --store test-default --set-default
-# local login
-ADMIN_API_BASE_URL='http://${STORE_ID}.swell.test:4001/admin/api' swell login
+swell login --set-default
 ```
 
-## Storefront
+## Storefronts
 
-### Settings
-
-Push or pull storefront settings. Scopes include `settings`, `editor` and `menus`.
+List all storefronts associated to logged in user:
 
 ```sh
-# pull => retrieves settings from the server and tries to merge and/or write to a specified JSON file or stdout
-swell settings pull SCOPE [--file (-f) String] [--output (-o) Boolean] [--strategy String]
-
-# push => send settings from a JSON file or stdin to the server
-swell settings push SCOPE [--file (-f) String] [--input (-i) Boolean] [--strategy String]
+swell storefronts list
 ```
 
-### Examples
-
+Retrieves storefront configuration data from the server and writes it to a file if specified or stdout by default. It requires a type to run. Configuration types allowed are "editor", "menus" and "settings":
 ```sh
-swell storefront settings pull settings -f settings/store.json
-swell storefront settings pull settings -f settings/store.json --strategy ours # keeps our version of the file in case of conflicts
-
-swell storefront settings push editor -f settings/editor.json
-swell storefront settings push editor -f settings/editor.json --strategy "set" # overwrites the settings object instead of merging
-
-cat settings/menus.json | swell storefront settings push menus -i --strategy "defaults" # merges remote settings on top of the settings being pushed, as a default mechanism
+swell storefronts pull --id String --type (-t) String [--file (-f) String]
 ```
 
-### SSH Keys
-
-Manage a user's SSH keys to a storefront. Needs session authentication (`swell login`).
-
+Send storefront configuration data to the server. Configuration types allowed are "editor", "menus" and "settings":
 ```sh
-swell storefront ssh-keys list
-swell storefront ssh-keys add [--name String]
-swell storefront ssh-keys delete KEY_ID [--dry-run Boolean]
+swell storefronts push --id String --type (-t) String [--file (-f) String] [--strategy (-i) String]
 ```
 
 ### Examples
 
 ```sh
-swell storefront ssh-keys list
-swell storefront ssh-keys add --name deploy-key
-swell storefront ssh-keys delete abcdef1234567890
+swell storefronts pull --id P5OzfzLD -t editor
+swell storefronts pull --id P5OzfzLD -t menus -f menus.json
+swell storefronts push --id P5OzfzLD -t editor -s set -f ../origin-storefront/config/editor.json
 ```
 
 ## Model
@@ -85,12 +71,12 @@ swell storefront ssh-keys delete abcdef1234567890
 Push or pull model definitions, including namespaced models (e.g. content models), abstract content models and content fields.
 
 ```sh
-# pull => retrieves a model from the server and tries to merge and/or write to a specified JSON file or stdout
+# pull => retrieves a model from the server and tries to merge and/or write to a specified JSON file or stdout (by default)
 # --content flag toggles between base models and abstract content models or content fields
-swell model pull MODEL_ID [--file (-f) String] [--output (-o) Boolean] [--strategy String] [--content Boolean]
+swell model pull -m MODEL_ID [--file (-f) String] [--strategy (-s) String] [--content Boolean]
 
 # push => send a model definition from a JSON file or stdin to the server
-swell model push [--file (-f) String] [--input (-i) Boolean] [--content Boolean]
+swell model push [--file (-f) String] [--input (-i) stdin] [--content Boolean]
 ```
 
 It is important that the model definition includes some fields depending on the type/source of the model.
@@ -129,32 +115,9 @@ It is important that the model definition includes some fields depending on the
 ### Examples
 
 ```sh
-swell model pull products -f models/products.json
-swell model pull products -f models/products.json --strategy ours # keeps our version of the file in case of conflicts
-swell model pull theme.origin.page --content --f models/page.json # pull a content model
+swell model pull -m products # pull products model and display in stdout
+swell model pull -m theme.origin.page --content -f models/page.json # pull a content model and save it to a file
 
 swell model push -f models/orders.json
-swell model push --content --f models/page.json # push a content model
-```
-
-## Settings
-
-Push or pull store settings (e.g. payments, shipping, etc...)
-
-```sh
-# pull => retrieves settings from the server and tries to merge and/or write to a specified JSON file or stdout
-swell settings pull SCOPE [--file (-f) String] [--output (-o) Boolean] [--strategy String]
-
-# push => send settings from a JSON file or stdin to the server
-swell settings push SCOPE [--file (-f) String] [--input (-i) Boolean] [--strategy String]
-```
-
-### Examples
-
-```sh
-swell settings pull payments -f settings/payments.json
-swell settings pull payments -f settings/payments.json --strategy ours # keeps our version of the file in case of conflicts
-
-swell settings push payments -f settings/payments.json
-swell settings push payments -f settings/payments.json --strategy "set" # overwrites the settings object instead of merging
+swell model push -c -f models/page.json # push a content model
 ```

package/dist/bin/{multipart-parser-2c48c5f2.js → multipart-parser-97941dba.js}

@@ -1,29 +1,27 @@
 #!/usr/bin/env node
 
-import 'fs';
-import 'path';
-import { F as FormData, a as File } from './swell-b7920988.js';
-import 'assert';
-import 'child_process';
-import 'async_hooks';
-import 'util';
-import 'process';
-import 'os';
-import 'tty';
-import 'stream';
-import 'string_decoder';
-import 'buffer';
-import 'events';
-import 'url';
-import 'http';
-import 'https';
-import 'zlib';
-import 'stream/web';
-import 'net';
-import 'worker_threads';
-import 'readline';
-import 'constants';
-import 'crypto';
+import { F as FormData, a as File } from './swell-cfd63c19.js';
+import 'node:assert';
+import 'node:child_process';
+import 'node:async_hooks';
+import 'node:util';
+import 'node:process';
+import 'node:os';
+import 'node:tty';
+import 'node:fs';
+import 'node:path';
+import 'node:stream';
+import 'node:string_decoder';
+import 'node:buffer';
+import 'node:events';
+import 'node:url';
+import 'node:http';
+import 'node:https';
+import 'node:zlib';
+import 'node:net';
+import 'node:readline';
+import 'node:constants';
+import 'node:crypto';
 
 let s = 0;
 const S = {