astra-cli

oclif-hello-world

oclif example Hello World CLI

• Usage
• Commands

Usage

$ npm install -g astra-cli
$ astra COMMAND
running command...
$ astra (--version)
astra-cli/0.1.24 darwin-arm64 node-v19.4.0
$ astra --help [COMMAND]
USAGE
  $ astra COMMAND
...

Commands

• astra build
• astra check
• astra create
• astra dev
• astra help [COMMANDS]

astra build

Say Build

USAGE
  $ astra build

DESCRIPTION
  Say Build

EXAMPLES
  $ astra build
    launch build (./src/commands/build/index.ts)

See code: dist/commands/build/index.js

astra check

Validate the theme.

USAGE
  $ astra check [--verbose] [--path <value>] [-a] [-c <value>] [-C <value>] [-x <value>] [--fail-level
    error|suggestion|style] [--init] [--list] [-o text|json] [--print] [-v]

FLAGS
  -C, --config=<value>            Use the config provided, overriding .theme-check.yml if present
                                  Use :theme_app_extension to use default checks for theme app extensions
  -a, --auto-correct              Automatically fix offenses
  -c, --category=<value>          Only run this category of checks
                                  Runs checks matching all categories when specified more than once
  -o, --output=<option>           [default: text] The output format to use
                                  <options: text|json>
  -v, --version                   Print Theme Check version
  -x, --exclude-category=<value>  Exclude this category of checks
                                  Excludes checks matching any category when specified more than once
  --fail-level=<option>           Minimum severity for exit with error code
                                  <options: error|suggestion|style>
  --init                          Generate a .theme-check.yml file
  --list                          List enabled checks
  --path=<value>                  [default: .] The path to your theme directory.
  --print                         Output active config to STDOUT
  --verbose                       Increase the verbosity of the logs.

DESCRIPTION
  Validate the theme.

See code: dist/commands/check/index.js

astra create

Say Create

USAGE
  $ astra create

DESCRIPTION
  Say Create

EXAMPLES
  $ astra create
      create new project (./src/commands/create/index.ts)

See code: dist/commands/create/index.js

astra dev

Uploads the current theme as a development theme to the connected store, then prints theme editor and preview URLs to your terminal. While running, changes will push to the store in real time.

USAGE
  $ astra dev [--verbose] [--path <value>] [--host <value>] [--live-reload hot-reload|full-page|off]
    [--poll] [-e] [--port <value>] [-s <value>] [-t <value>] [-o <value>] [-x <value>] [--password <value>]

FLAGS
  -e, --theme-editor-sync
      Synchronize Theme Editor updates in the local theme files.

  -o, --only=<value>...
      Hot reload only files that match the specified pattern.

  -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.

  -x, --ignore=<value>...
      Skip hot reloading any files that match the specified pattern.

  --host=<value>
      Set which network interface the web server listens on. The default value is 127.0.0.1.

  --live-reload=<option>
      [default: hot-reload] The live reload mode switches the server behavior when a file is modified:
      - hot-reload Hot reloads local changes to CSS and sections (default)
      - full-page  Always refreshes the entire page
      - off        Deactivate live reload
      <options: hot-reload|full-page|off>

  --password=<value>
      Password generated from the Theme Access app.

  --path=<value>
      [default: .] The path to your theme directory.

  --poll
      Force polling to detect file changes.

  --port=<value>
      Local port to serve theme preview from.

  --verbose
      Increase the verbosity of the logs.

DESCRIPTION
  Uploads the current theme as a development theme to the connected store, then prints theme editor and preview URLs to
  your terminal. While running, changes will push to the store in real time.

See code: dist/commands/dev/index.js

astra help [COMMANDS]

Display help for astra.

USAGE
  $ astra 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 astra.

See code: @oclif/plugin-help