ezgames-cli

EZGames CLI Toolkit

• Usage
• Commands

Usage

$ npm install -g ezgames-cli
$ ezgames COMMAND
running command...
$ ezgames (-v|--version|version)
ezgames-cli/0.0.10 darwin-x64 node-v16.16.0
$ ezgames --help [COMMAND]
USAGE
  $ ezgames COMMAND
...

Commands

• ezgames app:exec TARGET COMMAND
• ezgames app:restart
• ezgames app:start
• ezgames app:status
• ezgames app:stop
• ezgames app:upgrade
• ezgames autocomplete [SHELL]
• ezgames bridge:start
• ezgames bridge:stop
• ezgames bridge:test NAME
• ezgames build:front
• ezgames config
• ezgames create:user
• ezgames help [COMMAND]
• ezgames install
• ezgames ssl:sign [FILE]
• ezgames test
• ezgames update [CHANNEL]

ezgames app:exec TARGET COMMAND

Executes the provided command inside the targeted docker compose service

USAGE
  $ ezgames app:exec TARGET COMMAND

ARGUMENTS
  TARGET   The name of the docker compose service inside which the command is to be executed.
  COMMAND  The the desired command to be executed.

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ ezgames exec

See code: src/commands/app/exec.ts

ezgames app:restart

Restarts EZGames's containers

USAGE
  $ ezgames app:restart

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ ezgames restart

See code: src/commands/app/restart.ts

ezgames app:start

Starts EZGames's containers

USAGE
  $ ezgames app:start

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ ezgames start
  $ ezgames up

See code: src/commands/app/start.ts

ezgames app:status

Shows the status of the internal infrastructure

USAGE
  $ ezgames app:status

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ ezgames status

See code: src/commands/app/status.ts

ezgames app:stop

Stops EZGames's containers

USAGE
  $ ezgames app:stop

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ ezgames stop
  $ ezgames down

See code: src/commands/app/stop.ts

ezgames app:upgrade

EZGames Updater

USAGE
  $ ezgames app:upgrade

OPTIONS
  -h, --help            show CLI help
  -l, --list            Lists available upgrade targets
  -t, --target=target   The version you wish to upgrade to
  --allow-pre-releases  Allows the user to select a pre-release as upgrade target
  --[no-]maintenance    Puts the app into maintenance mode before starting the upgrade process

ALIASES
  $ ezgames upgrade

See code: src/commands/app/upgrade.ts

ezgames autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ ezgames autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

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

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

See code: @oclif/plugin-autocomplete

ezgames bridge:start

Starts the bridge server

USAGE
  $ ezgames bridge:start

OPTIONS
  -H, --host=host  [default: 0.0.0.0]
  -P, --port=port  [default: 6660]
  -h, --help       show CLI help

See code: src/commands/bridge/start.ts

ezgames bridge:stop

Stops the bridge server

USAGE
  $ ezgames bridge:stop

OPTIONS
  -h, --help  show CLI help

See code: src/commands/bridge/stop.ts

ezgames bridge:test NAME

describe the command here

USAGE
  $ ezgames bridge:test NAME

OPTIONS
  -h, --help  show CLI help

See code: src/commands/bridge/test.ts

ezgames build:front

(Re)Build EZGames's FontEnd Application

USAGE
  $ ezgames build:front

OPTIONS
  -h, --help  show CLI help

See code: src/commands/build/front.ts

ezgames config

describe the command here

USAGE
  $ ezgames config

OPTIONS
  -d, --domain=domain  Domain Name or IPv4
  -h, --help           show CLI help
  -m, --email=email    WebMaster's email address
  -n, --name=name      Community Name

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

ezgames create:user

Create a user

USAGE
  $ ezgames create:user

OPTIONS
  -h, --help               show CLI help
  -m, --email=email        Email of the future user
  -n, --username=username  Username of the future user
  -p, --password=password  Password username of the future user
  -r, --role=role          Role to be assigned to the future user

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

ezgames help [COMMAND]

display help for ezgames

USAGE
  $ ezgames help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

ezgames install

EZGames Installer

USAGE
  $ ezgames install

OPTIONS
  -h, --help             show CLI help
  -r, --release=release  GitHub Release Tag

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

ezgames ssl:sign [FILE]

describe the command here

USAGE
  $ ezgames ssl:sign [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/ssl/sign.ts

ezgames test

Dummy Command used to test features

USAGE
  $ ezgames test

OPTIONS
  -h, --help  show CLI help

See code: src/commands/test.ts

ezgames update [CHANNEL]

update the ezgames CLI

USAGE
  $ ezgames update [CHANNEL]

OPTIONS
  --from-local  interactively choose an already installed version

See code: @oclif/plugin-update