admin cli

• Install
• Usage
  • Commands
    • collect
    • create
    • generate
    • install
    • mutate
    • publish
    • validate

Install

npm install @gruzf/admin-cli

or

yarn add @gruzf/admin-cli

Usage

Usage: admin-cli [options] [command]

Options:
  -h, --help     display help for command
  -v, --version  output the version number

Commands:
  collect|c   Collect application pages info
  create      Create a Control Panel project           default
  generate|g  Generate files for the project
  install|i   Install modules
  mutate|m    Mutate
  publish|p   Publish project info
  validate|v  Validate application

Commands

collect

Usage: admin-cli collect|c [options]

Collect application pages info

Options:
  --appDomain <name>      Defining environment
                          "APP_DOMAIN" name.
  -i, --ignore [path...]  Ignore files in glob format
  -p, --pages             Collect app pages

create

Usage: admin-cli create

Create a Control Panel project

generate

Usage: admin-cli generate|g [options]

Generate files for the project

Options:
  -i, --ignore [path...]  Ignore files in glob format
  -m, --menu              Generate a menu based on pages

install

Usage: admin-cli install|i

Install modules

mutate

Usage: admin-cli mutate|m [options]

Mutate

Options:
  --metadata [variant]    Mutate "Next.js" Metadata type
                          and pages Metadata ids
  -i, --ignore [path...]  Ignore files in glob format
  -ri, --reinstall        Reinstall project dependencies

publish

Usage: admin-cli publish|p [options]

Publish project info

Options:
  --env [variables...]    Defining environment variables
                          names. Supported list:
                          'api_url', 'api_key',
                          'app_domain', 'app_host'.
                          Example: --env api_url=API_URL
  --verifyPages           Verify if local config pages
                          matches the published version
  -c, --config            Publish project config
                          (file:"config.json")
  -i, --ignore [path...]  Ignore files in glob format

validate

Usage: admin-cli validate|v [options]

Validate application

Options:
  -i, --ignore [path...]  Ignore files in glob format
  -m, --metadata          Validate application pages
                          metadata