Iris-CLI

Iris CMS CLI

• Usage
• Commands

Usage

$ npm install -g iris-cms-cli
$ iris COMMAND
running command...
$ iris (-v|--version|version)
iris-cms-cli/1.0.2 linux-x64 node-v12.20.0
$ iris --help [COMMAND]
USAGE
  $ iris COMMAND
...

Commands

• iris autocomplete [SHELL]
• iris build
• iris clear:cache
• iris create NAME
• iris deploy [ARGS]
• iris help [COMMAND]
• iris init [FILE]
• iris init:user
• iris install
• iris serve
• iris upgrade [VERSION]

iris autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ iris autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ iris autocomplete
  $ iris autocomplete bash
  $ iris autocomplete zsh
  $ iris autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

iris build

Build both functions, cms.

USAGE
  $ iris build

OPTIONS
  -h, --help              show CLI help
  --only=(functions|cms)  use this options if want run only one of them.

DESCRIPTION
  basically it call 'npm run build' on folder functions & cms. Just Syntax sugar if you call.

See code: src/commands/build.ts

iris clear:cache

Clear Download Cache

USAGE
  $ iris clear:cache

OPTIONS
  -h, --help  show CLI help

See code: src/commands/clear/cache.ts

iris create NAME

Create Iris Project

USAGE
  $ iris create NAME

ARGUMENTS
  NAME  [default: iris] Project Name to be created

OPTIONS
  -f, --force  make download from server.
  -h, --help   show CLI help

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

iris deploy [ARGS]

deploy to firebase.

USAGE
  $ iris deploy [ARGS]

OPTIONS
  -h, --help  show CLI help

DESCRIPTION
  syntax sugar to 'firebase deploy' with args

See code: src/commands/deploy.ts

iris help [COMMAND]

display help for iris

USAGE
  $ iris help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

iris init [FILE]

Init Iris CMS.

USAGE
  $ iris init [FILE]

OPTIONS
  -b, --no-build           Do not build
  -c, --no-init-call       Do not call init functions.
  -d, --no-deploy          Do not deploy to firebase
  -e, --email=email        Email to Register
  -h, --help               show CLI help
  -i, --no-install         Do not install
  -p, --password=password  Password to Register

DESCRIPTION
  its just multiple command 'install', 'build, 'firebase deploy', & 'init:user'

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

iris init:user

Init User for super admin.

USAGE
  $ iris init:user

OPTIONS
  -e, --email=email        Email to Register
  -h, --help               show CLI help
  -p, --password=password  Password to Register

DESCRIPTION
  this can be called once per project. second time will be ignored as success.

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

iris install

Install All dependency using yarn or npm.

USAGE
  $ iris install

OPTIONS
  -h, --help  show CLI help

DESCRIPTION
  syntax sugar for 'npm i' or 'yarn' on folder functions or cms.

See code: src/commands/install.ts

iris serve

Run CMS on firebase emulators.

USAGE
  $ iris serve

OPTIONS
  -h, --help  show CLI help
  -i, --init  init emulator

DESCRIPTION
  some functionality may not running as expected because emulator is not perfect.

See code: src/commands/serve.ts

iris upgrade [VERSION]

Upgrade your Iris version.

USAGE
  $ iris upgrade [VERSION]

OPTIONS
  -h, --help  show CLI help

DESCRIPTION
  latest(default) if not specified.

See code: src/commands/upgrade.ts