Skip to content

Latest commit

 

History

History
314 lines (231 loc) · 10.8 KB

readme.md

File metadata and controls

314 lines (231 loc) · 10.8 KB

Commands

shopkeeper bucket create

Create a bucket in .shopkeeper

USAGE
  $ shopkeeper bucket create -b <value> [--no-color] [--verbose]

FLAGS
  -b, --bucket=<value>...  (required)
      --no-color           Disable color output.
      --verbose            Increase the verbosity of the logs.

DESCRIPTION
  Create a bucket in .shopkeeper

See code: src/commands/bucket/create.ts

shopkeeper bucket current

Output the current bucket

USAGE
  $ shopkeeper bucket current [--no-color] [--verbose]

FLAGS
  --no-color  Disable color output.
  --verbose   Increase the verbosity of the logs.

DESCRIPTION
  Output the current bucket

See code: src/commands/bucket/current.ts

shopkeeper bucket delete

Delete a bucket

USAGE
  $ shopkeeper bucket delete -b <value> [--no-color] [--verbose] [-f]

FLAGS
  -b, --bucket=<value>...  (required)
  -f, --force              Skip confirmation.
      --no-color           Disable color output.
      --verbose            Increase the verbosity of the logs.

DESCRIPTION
  Delete a bucket

See code: src/commands/bucket/delete.ts

shopkeeper bucket init

Initialize .shopkeeper directory in the current directory

USAGE
  $ shopkeeper bucket init [--no-color] [--verbose] [-b <value>]

FLAGS
  -b, --bucket=<value>...
      --no-color           Disable color output.
      --verbose            Increase the verbosity of the logs.

DESCRIPTION
  Initialize .shopkeeper directory in the current directory

See code: src/commands/bucket/init.ts

shopkeeper bucket list

List buckets

USAGE
  $ shopkeeper bucket list [--no-color] [--verbose]

FLAGS
  --no-color  Disable color output.
  --verbose   Increase the verbosity of the logs.

DESCRIPTION
  List buckets

See code: src/commands/bucket/list.ts

shopkeeper bucket restore

Restores the theme settings from the specified bucket

USAGE
  $ shopkeeper bucket restore [--no-color] [--verbose] [--path <value>] [-e <value>] [--bucket <value>] [-n]

FLAGS
  -e, --environment=<value>  The environment to apply to the current command.
  -n, --nodelete             Runs the restore command without removing the theme's JSON settings.
      --bucket=<value>       The bucket you want to restore your settings from.
      --no-color             Disable color output.
      --path=<value>         The path to your theme directory.
      --verbose              Increase the verbosity of the logs.

DESCRIPTION
  Restores the theme settings from the specified bucket

See code: src/commands/bucket/restore.ts

shopkeeper bucket save

Saves the current theme settings to the specified bucket

USAGE
  $ shopkeeper bucket save [--no-color] [--verbose] [--path <value>] [-e <value>] [--bucket <value>] [-n]

FLAGS
  -e, --environment=<value>  The environment to apply to the current command.
  -n, --nodelete             Runs the save command without deleting the bucket's contents.
      --bucket=<value>       The bucket where you want to save your settings.
      --no-color             Disable color output.
      --path=<value>         The path to your theme directory.
      --verbose              Increase the verbosity of the logs.

DESCRIPTION
  Saves the current theme settings to the specified bucket

See code: src/commands/bucket/save.ts

shopkeeper bucket switch

Switches the current bucket by copying settings and .env

USAGE
  $ shopkeeper bucket switch [--no-color] [--verbose] [--path <value>] [-e <value>] [--bucket <value>] [-n]

FLAGS
  -e, --environment=<value>  The environment to apply to the current command.
  -n, --nodelete             Runs the restore command without removing the theme's JSON settings.
      --bucket=<value>       The bucket to switch to
      --no-color             Disable color output.
      --path=<value>         The path to your theme directory.
      --verbose              Increase the verbosity of the logs.

DESCRIPTION
  Switches the current bucket by copying settings and .env

See code: src/commands/bucket/switch.ts

shopkeeper help [COMMANDS]

Display help for shopkeeper.

USAGE
  $ shopkeeper help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for shopkeeper.

See code: @oclif/plugin-help

shopkeeper theme create

Create a theme with a name or ID. Update theme if one with name already exists

USAGE
  $ shopkeeper theme create -t <value> [--no-color] [--verbose] [--path <value>] [--password <value>] [-s <value>]
    [-e <value>] [-n] [-j]

FLAGS
  -e, --environment=<value>  The environment to apply to the current command.
  -j, --json                 Output JSON instead of a UI.
  -n, --nodelete             Runs the push command without deleting local files.
  -s, --store=<value>        Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL
                             (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
  -t, --theme=<value>        (required) Theme ID or name of the remote theme.
      --no-color             Disable color output.
      --password=<value>     Password generated from the Theme Access app.
      --path=<value>         The path to your theme directory.
      --verbose              Increase the verbosity of the logs.

DESCRIPTION
  Create a theme with a name or ID. Update theme if one with name already exists

  Create a theme with theme name or ID.
  In most cases, you should use theme push.

  This command exists for the case when you want create a theme by name that may
  or may not exist. It will ensure that if one with the same name already exists,
  it is updated.

  theme push --unpublished --theme yellow will create a new theme named yellow each
  time the command is run.

  As a result this command exists.

See code: src/commands/theme/create.ts

shopkeeper theme deploy

Deploy theme source to store

USAGE
  $ shopkeeper theme deploy [--no-color] [--verbose] [--path <value>] [--password <value>] [-s <value>] [-e
    <value>] [-n] [--publish] [--green <value>] [--blue <value>] [--strategy blue-green|basic]

FLAGS
  -e, --environment=<value>  The environment to apply to the current command.
  -n, --nodelete             Runs the push command without deleting local files.
  -s, --store=<value>        Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL
                             (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
      --blue=<value>         Blue theme ID
      --green=<value>        Green theme ID
      --no-color             Disable color output.
      --password=<value>     Password generated from the Theme Access app.
      --path=<value>         The path to your theme directory.
      --publish              Publishes the on-deck theme after deploying
      --strategy=<option>    [default: blue-green] Strategy to use for deployment
                             <options: blue-green|basic>
      --verbose              Increase the verbosity of the logs.

DESCRIPTION
  Deploy theme source to store

See code: src/commands/theme/deploy.ts

shopkeeper theme get

Get details of theme

USAGE
  $ shopkeeper theme get -t <value> [--no-color] [--verbose] [-s <value>] [--password <value>] [-j]

FLAGS
  -j, --json              Output JSON instead of a UI.
  -s, --store=<value>     Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL
                          (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
  -t, --theme=<value>     (required) Theme ID or name of the remote theme.
      --no-color          Disable color output.
      --password=<value>  Password generated from the Theme Access app.
      --verbose           Increase the verbosity of the logs.

DESCRIPTION
  Get details of theme

See code: src/commands/theme/get.ts

shopkeeper theme settings download

Download settings from live theme.

USAGE
  $ shopkeeper theme settings download [--no-color] [--verbose] [--path <value>] [--password <value>] [-s <value>] [-e
    <value>] [-t <value>] [-n]

FLAGS
  -e, --environment=<value>  The environment to apply to the current command.
  -n, --nodelete             Runs the pull command without deleting local files.
  -s, --store=<value>        Store URL. It can be the store prefix (johns-apparel) or the full myshopify.com URL
                             (johns-apparel.myshopify.com, https://johns-apparel.myshopify.com).
  -t, --theme=<value>        Theme ID or name of the remote theme.
      --no-color             Disable color output.
      --password=<value>     Password generated from the Theme Access app.
      --path=<value>         The path to your theme directory.
      --verbose              Increase the verbosity of the logs.

DESCRIPTION
  Download settings from live theme.

See code: src/commands/theme/settings/download.ts