Login Command

Generate new Credentials to authenticate with Catalytic

๐Ÿ“˜

View the Authentication in Catalytic CLI docs for general information on Authentication.

Overview

Catalytic Login

Usage:
    catalytic login
    catalytic login (help | -h | --help)
    catalytic login --team=<Team> [--email=<Email> --password=<Password>] [--credentialsName=<CredentialsName>]

Options:
    -h --help                            Show help.
    --team=<Team>                    The name of your Catalytic team (i.e. myteam or myteam.pushbot.com).
    --email=<Email>                      The email address associated with your Catalytic account. Do not specify if your team uses SSO for Catalytic.
    --password=<Password>                The password associated with your Catalytic account.  Do not specify if your team uses SSO for Catalytic.
    --credentialsName=<CredentialsName>  The optionally specified name to associate with the account. Defaults to <Team>.

โš ๏ธ

If your Catalytic team uses SSO, do not provide email and password

Instead, your browser will open to a page where the new User Token can be approved.

Login via StdIn

$ catalytic login

The command creates and saves new User Token for use with other CLI commands. This command will prompt you for your Catalytic team name, email, password, and a nickname for you Credentials.

Example

$ catalytic login
  Catalytic team name or domain (i.e.'companyname' or 'companyname.pushbot.com'): bluth-company
  Credentials nickname (Default='bluth-company'): cli-credentials
  Catalytic user email (leave empty if Catalytic team uses SSO): [email protected]
  Catalytic user password: **************

Login via Arguments

$ catalytic login --team=<Team> [--email=<Email> --password=<Password>] [--credentialsName=<CredentialsName>]

The command creates and saves new User Token for use with other CLI commands.

OptionDescription
--team=<Team>The name or domain of your Catalytic team (i.e.'companyname' or 'companyname.pushbot.com').
--email=<Email>The email address associated with your Catalytic account. Do not specify if your team uses SSO for Catalytic.
--password=<Password>The password associated with your Catalytic account. Do not specify if your team uses SSO for Catalytic.
--credentialsName=<CredentialsName>The optionally specified name to associate with the account. Defaults to . See Credentials Management Commands for more information on how this is used.

This command may be used if you do not wish to enter information via StdIn.

Example

$ catalytic login --team 'bluth-company' --email '[email protected]' --password '[email protected]$$w0rd' --credentialsName 'cli-credentials'