NorthStack CLI

Last Updated February 4, 2019

The NorthStack CLI

northstack@ns-dev ~/northstack $ northstack

Usage:
command [options] [arguments]

Options:

  • -h, --help Display this help message
  • -q, --quiet Do not output any message
  • -V, --version Display this application version
  • --ansi Force ANSI output
  • --no-ansi Disable ANSI output
  • -n, --no-interaction Do not ask any interactive question
  • --no-time-limit Prevent the command from ending at the regular time limit
  • -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Available commands:

  • _completion BASH completion hook.
  • help Displays help for a command
  • list Lists commands
  • signup NorthStack Signup
  • app
    • app:create NorthStack App Create
    • app:deploy NorthStack App Create
    • app:logs NorthStack App Logs
  • auth
    • auth:client-login Login using client id & secret and save access token
  • org
    • org:login Login and get save access token
    • org:logout End Session and Logout

Sign-Up Example

northstack@ns-dev ~/northstack $ northstack signup
Organization Name: superduper
Username: keith
Password: ••••••••••••
Owner Name: Keith McKeitherton
Owner Email: keith@superduper.com
Success! Welcome to NorthStack, keith.
Your account details have been written to /home/ubuntu/northstack/account.json for safekeeping.
You can sign into your account by running `northstack org:login keith`.


App:Create

northstack@ns-dev ~/northstack $ northstack app:create --help

Usage:
app:create [options] [--] <name> <primaryDomain> [<baseFolder>] [<orgId>] [<cluster>]

Arguments:

  • name App name
  • primaryDomain Primary Domain
  • baseFolder Folder to create/install to (defaults to current directory)
  • orgId Org ID (defaults to value in accounts.json in the current directory)
  • cluster cluster [default: “dev-us-east-1”]

Options:

  • --authToken=AUTHTOKEN Access Token
  • --authClientId=AUTHCLIENTID OAuth Client ID [default: 2]
  • --authClientSecret=AUTHCLIENTSECRET Client Secret
  • --authUsername=AUTHUSERNAME Username
  • --authPassword=AUTHPASSWORD Password
  • --authMfa=AUTHMFA MFA Code
  • --authScope=AUTHSCOPE Scopes (multiple values allowed)
  • -h, --help Display this help message’
  • -q, --quiet Do not output any message
  • -V, --version Display this application version
  • --ansi Force ANSI output
  • --no-ansi Disable ANSI output
  • -n, --no-interaction Do not ask any interactive question
  • --no-time-limit Prevent the command from ending at the regular time limit
  • -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

 

app:create Example

northstack@ns-dev ~/northstack $ northstack app:create superduper-blog superduper.com
Woohoo! Your NorthStack instance (superduper-blog) was created successfully. Here are your prod, testing, and dev apps:

————————————————
id
————————————————
tg9hCzLdSVV2ZTdsM38qzT
CQzrG37Q9pZgGp6yWR5UC8
bXsdZtX2dKNPQrcs72Pc8B
————————————————
————————
environment
————————
prod
test
dev
————————
——————————————————————————————————
fqdn
——————————————————————————————————
superduper.com
ns-CQzrG37Q9pZgGp6yWR5UC8.test.northstack.com
ns-bXsdZtX2dKNPQrcs72Pc8B.dev.northstack.com
——————————————————————————————————
—————————————————————————————————————-
config path
—————————————————————————————————————-
/home/ns-dev/northstack/superduper-blog/config/prod
/home/ns-dev/northstack/superduper-blog/config/test
/home/ns-dev/northstack/superduper-blog/config/dev
—————————————————————————————————————-

We’re not quite ready yet.. Coming soon