Deployer

Employment Hero CLI

A CLI application to interact with Employment Hero microservices infrastructure.

Installation:

• Using npm : npm install -g ehcli
• Using yarn: yarn global add ehcli

Usages:

  Usage: hero [options] [command]


  Commands:

    apps:list|apps [options]                            list your apps
    apps:info|info [options]                            show detailed app information
    apps:status|status [options]                        show app deployment status
    apps:create|create [options] <name> <chart>         create a new app definition based on chart and push to Firebase
    apps:setup|setup [options] <manifest>               setup app for the first time based on provided manifest (app.json)
    apps:init|init [options] <manifest>                 initialize app based on provided manifest (app.json).This replaces repo:create + app:create + app:setup.
    apps:restart|restart [options]                      restart app
    apps:scale|scale [options] <key=value> [others...]  scale an app
    releases:list|releases [options]                    display the releases for an app
    releases:rollback|rollback [options]                rollback a release of an app to a certain revision
    config:get|config [options] [key]                   display the config vars for an app
    config:set [options] <key=value> [others...]        set one or more config vars
    config:unset [options] <key>                        unset a config var
    version                                             print the client/server version information
    logs [options]                                      display recent log output
    ci:build|build [options] <manifest>                 build docker image based on provided manifest (app.json)
    ci:push|push [options] <manifest>                   push docker image based on provided manifest (app.json)
    ci:pull|pull [options] <manifest>                   pull docker image based on provided manifest (app.json)
    ci:deploy|deploy [options] <manifest>               deploy new version based on provided manifest (app.json)
    manifest:validate <manifest>                        validate a manifest file (app.json)
    manifest:get <manifest> <jsonPath>                  get a field from manifest file (app.json)
    auth:login|login [options]                          login with your Github credentials
    auth:logout|logout                                  clear local authentication credentials
    auth:token|token                                    display your api token
    auth:whoami|whoami                                  display your account details
    run [options] <command> [args...]                   run a one-off process inside a Kubernetes container
    procs:list|procs [options]                          list your app's procs
    repos:create <name>                                 create a new repo in Amazon EC2 Container Registry
    files:add [options] <name> <filepath>               add a file
    files:rm [options] <name>                           remove a file
    slack:notify <channel> <text>                       send notification to slack channel
    endpoints:list|endpoints [options]                  list your endpoints
    endpoints:create [options] <manifest>               create an endpoint in Kong (app.json)
    help                                                output usage information

  Options:

    -h, --help     output usage information
        --dry-run  simulate the command

  Examples:

    $ hero apps:list --context $STAGING_CLUSTER                          # list all apps
    $ hero apps --context $STAGING_CLUSTER                               # same as above, apps is an alias for apps:list
    $ hero config:get -a announcement-api --context $STAGING_CLUSTER     # get all env config for app announcement-api