# Pandium CLI

## Notes

* This tool is currently only available for Mac OS users.
* The Pandium CLI will only interface with internal integrations running on the Pandium platform.
* To use this tool, you will need to create an integration and tenant in the Pandium Integration Hub, with fully provisioned connectors.
* Running an integration locally in init mode will not update the dynamic configs available to this tenant on the Integration Hub.

## Installation

The terminal command to download the Pandium CLI can be accessed directly from the Pandium Admin Dashboard.

1. Log into the Pandium Admin Dashboard
2. Navigate to Settings > Developer Resources

<figure><img src="https://4017407078-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfJn-9R_dn6dvcGNcdk%2Fuploads%2FQJUWinX85JWd3jEA5zC0%2FScreenshot%202025-03-18%20at%203.58.11%E2%80%AFPM.png?alt=media&#x26;token=f43f3da7-6678-4d17-9686-b9579e7820b2" alt=""><figcaption></figcaption></figure>

3. Copy the command for your system (E.g. MacOS aarch64 (Apple Silicon))
   1. If you don't see a command listed for your platform of choice, please let us know.

<figure><img src="https://4017407078-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MfJn-9R_dn6dvcGNcdk%2Fuploads%2FlXcPMjSbsWxOMMvnDFFd%2FScreenshot%202025-03-18%20at%204.01.55%E2%80%AFPM.png?alt=media&#x26;token=a248bc97-b0d2-4db6-ab74-f5f938e24d62" alt=""><figcaption></figcaption></figure>

4. Paste the command into your terminal and hit “Enter.”
5. Follow the documentation below to start using the CLI and run commands based on your needs.&#x20;

## Authenticate

To list and manage your integrations, authenticate using the following command:

```
pandium login [environment]
```

If no environment is provided, it will default to sandbox. Possible environment values currently are *sandbox*, *sandbox-eu*, *demo*

## Usage

Get a list of all available commands:

```
pandium help
```

You will get the below output:

```
Usage:pandium login [environment]
   	pandium logout
   	pandium get integrations [integration_id]
   	pandium get tenants [OPTIONS] [tenant_id]
   	pandium get help [COMMAND]
   	pandium local build
   	pandium local run [OPTIONS] <tenant_id>
   	pandium local help [COMMAND]
   	pandium help [COMMAND]...

Options:
  -h, --help 	Print help
  -V, --version  Print version

pandium login:
Log in to Pandium! Takes environment name as an option, defaults to sandbox
  -h, --help     	Print help
  [environment]  [default: sandbox] [possible values: sandbox, sandbox-eu, demo]

pandium logout:
End your Pandium session
  -h, --help  Print help

pandium get:
Get internal integrations or their tenants
  -h, --help  Print help

pandium get integrations:
See a list of all your internal integrations
  -h, --help        	Print help
  [integration_id]

pandium get tenants:
See a list of tenant associated with the provided integration id
  -i, --integration-id <integration-id>
  	--include-active-secrets
  -h, --help                         	Print help
  [tenant_id]

pandium get help:
Print this message or the help of the given subcommand(s)

pandium local:
Execute commands from your local PANDIUM file (PANDIUM.yaml, PANDIUM.json, or PANDIUM.toml)
  -h, --help  Print help

pandium local build:
Execute the 'build' command in your PANDIUM.yaml
  -h, --help  Print help

pandium local run:
Run the integration found in the current folder using the env values from the provided tenant id. Local .env file will override any values saved in pandium
  -m, --mode <mode>  Optionally specify a run mode. Defaults to 'normal' [default: normal] [possible values: init, normal]
  -h, --help     	Print help
  <tenant_id>

pandium local help:
Print this message or the help of the given subcommand(s)

pandium help:
Print this message or the help of the given subcommand(s)
  [COMMAND]...  Print help for the subcommand(s)
```