Installation & Configuration

Installation

The Nomad Media CLI requires Python to be installed in your environment.

bash

Fresh installation

pip install nomad-media-cli

Upgrade to latest version

pip install --upgrade nomad-media-cli

Initialization Commands

init

Initializes the CLI configuration. Run this once to point the CLI at your Nomad Media environment. API key can be used in place of password. SSO credentials can be used in place of username and password.

bash nomad-media-cli init --service-api-url https://your-api.example.com --username [email protected] --password yourpassword

Options:

• --service-api-url (required): API endpoint URL.
• --api-type: API type — admin or portal. Default: admin.
• --debug: Enable debug mode — true or false. Default: false.
• --username: Username for credentials.
• --password: Password for credentials.
• --api-key: API key credential. (beta)
• --sso-provider: SSO provider credential. (beta)
• --sso-code: SSO code credential. (beta)
• --sso-state: SSO state credential. (beta)
• --sso-session-state: SSO session state credential. (beta)
• --sso-redirect-url: SSO redirect URL. Use quotes around the URL. (beta)

login

Logs into Nomad Media with the given credentials. Use this after init has been run at least once. Supports the same credential options as init.

Options:

• --username: Username for credentials.
• --password: Password for credentials.
• --api-key: API key credential. (beta)
• --sso-provider: SSO provider credential. (beta)
• --sso-code: SSO code credential. (beta)
• --sso-state: SSO state credential. (beta)
• --sso-session-state: SSO session state credential. (beta)
• --sso-redirect-url: SSO redirect URL. Use quotes around the URL. (beta)

logout

Logs the CLI out of Nomad Media. Removes the login token, refresh token, ID, and expiration from the config file.

list-config-path

Outputs the local OS path where the config file is stored.

update-config

Updates the CLI configuration without re-initializing.

Options:

• --service-api-url: API endpoint URL.
• --api-type: API type — admin or portal. Default: admin.
• --debug: Enable debug mode — true or false. Default: false.

Configuration File

The CLI stores configuration at a platform-specific path. Use list-config-path to find the exact location.

To use a custom configuration location, pass --config-path to any command.