modzy help

Provides help for any command in the application

$ modzy help [command] [flags] provides help for any command in the application.

Usage

Enter the following code into the terminal.

$ modzy help
You can provide your authentication token through any mixture of command flags,
ENV variables, or configuration files.  Precedence is command flag > ENV > configuration file.

The flags are:
- base-url
- api-key
- team-id
- team-token

The ENV variables are:
- MODZY_BASE_URL
- MODZY_API_KEY
- MODZY_TEAM_ID
- MODZY_TEAM_TOKEN

To use a configuration file, create a yaml file at any of these locations:
  - /etc/modzy/{profile}.yaml
  - $HOME/.modzy/{profile}.yaml.

The default profile is "default".

This file should look something like:

    > cat ~/.modzy/default.yaml
    base-url: https://base.url
    # use an api key:
    api-key: yourkey.here
    # or use a team key:
    team-id: yourteamid
    team-token: yourteam.token

You can troubleshoot your configuration using the "whoami" command:

    > modzy --profile dev whoami
    Configuration file: /home/user/.modzy/dev.yaml
            Base URL: base
            API Key: yourkey.***
            Team ID: yourteamid
            Team Token: yourteam.***

Usage:
  modzy [flags]
  modzy [command]

Available Commands:
  alerts      List all alerts
  completion  generate the autocompletion script for the specified shell
  help        Help about any command
  jobs        Work with jobs
  models      Work with models
  projects    Work with projects
  status      Returns top level dashboard information for your account
  whoami      Summarize effective authentication information

Flags:
      --api-key string      modzy API key to use for authentication
      --base-url string     modzy API base URL
  -h, --help                help for modzy
  -p, --profile string      use a profile located at $HOME/.modzy/{profile} (default "default")
      --team-id string      modzy API team ID to use for team authentication
      --team-token string   modzy API team token to use for team authentication
  -v, --verbose             enable more verbose log output for debugging purposes
      --verbose-http        enable log output of http request and response data

Use "modzy [command] --help" for more information about a command.

You can also use the help command to get help with a specific command.

$ modzy help alerts
List all alerts

Usage:
  modzy alerts [type] [flags]

Flags:
  -h, --help            help for alerts
  -o, --output string

Global Flags:
      --api-key string      modzy API key to use for authentication
      --base-url string     modzy API base URL
  -p, --profile string      use a profile located at $HOME/.modzy/{profile} (default "default")
      --team-id string      modzy API team ID to use for team authentication
      --team-token string   modzy API team token to use for team authentication
  -v, --verbose             enable more verbose log output for debugging purposes
      --verbose-http        enable log output of http request and response data

Flags
-h, --help help for help


Did this page help you?