pandium cli.md

Pandium CLI

Notes

This tool is currently in BETA. If you are a current Pandium customer who would like to use and provide feedback on the Pandium CLI, please contact your TAM for access.
This tool is currently only available for Mac OS users.
The Pandium CLI will only interface with internal apps 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.

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

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.

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

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)

Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the ask query parameter, and the optional goal query parameter:

GET https://docs.pandium.com/~/revisions/x7Thkx1S9I9SnLbXNFwg/reference/pandium-cli.md?ask=<question>&goal=<endgoal>

ask is the immediate question: it should be specific, self-contained, and written in natural language. goal is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.