npm package: @gruzf/admin-cli
Description: <!-- badgeSectionStart -->
Author: Vladislav Gevorgyan
Latest version: 1.13.2

# admin cli <!-- omit in toc -->

<!-- badgeSectionStart -->

[![Version](https://img.shields.io/badge/dynamic/json?color=green&label=numen&prefix=v&query=%24%5B%27dist-tags%27%5D.latest&url=https%3A%2F%2Fregistry.npmjs.org%2F%40gruzf%2Fnumen)](https://npmjs.org/package/@gruzf/numen)
[![Version](https://img.shields.io/badge/dynamic/json?color=green&label=numen-cli&prefix=v&query=%24%5B%27dist-tags%27%5D.latest&url=https%3A%2F%2Fregistry.npmjs.org%2F%40gruzf%2Fnumen-cli)](https://npmjs.org/package/@gruzf/numen-cli)

<!-- badgeSectionEnd -->

<!-- tocSectionStart -->

- [Install](#install)
- [Usage](#usage)
  - [Commands](#commands)
    - [collect](#collect)
    - [create](#create)
    - [generate](#generate)
    - [install](#install)
    - [mutate](#mutate)
    - [publish](#publish)
    - [validate](#validate)

<!-- tocSectionEnd -->

## Install

```bash
npm install @gruzf/admin-cli
```

or

```bash
yarn add @gruzf/admin-cli
```

<!-- usageSectionStart -->

## Usage

```bash
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
```

<!-- usageSectionEnd -->

<!-- commandsSectionStart -->

### Commands

#### collect

```bash
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

```bash
Usage: admin-cli create

Create a Control Panel project
```

#### generate

```bash
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

```bash
Usage: admin-cli install|i

Install modules
```

#### mutate

```bash
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

```bash
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

```bash
Usage: admin-cli validate|v [options]

Validate application

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

<!-- commandsSectionEnd -->