LogoLogo
  • Getting Started
    • Pandium Documentation
    • What is Pandium?
      • The Pandium Platform
      • What Companies Use Pandium For
      • Platform Structure
      • Users of Pandium
    • Anatomy of an Integration
      • Run Triggers
      • PANDIUM.yaml
        • Schema
        • UiSchema
        • Dynamic Configurations
        • Dependent Selector Configurations
      • Environment Variables
        • Context: StdOut
        • Logging (StdErr)
    • Key Terminology
    • Pandium Integration Tutorial
      • Pokémon of the Day, Part 1
        • Create App in Slack to get Credentials
        • Create Integration on the Pandium Integration Hub
        • Make a Tenant
        • Write the Integration in Typescript
          • Add the .env
          • Configure the PANDIUM.yaml
          • Check the Customized Connection Settings Page
          • Add the Pokémon client
          • Add the Slack Client
          • Add the pokemonSync flow
          • Run Normal Sync on the Tenant
        • Update the Tenant Schedule
      • Pokémon of the Day, Part 2
        • Update the PANDIUM.yaml
        • Check the Updated Connection Settings Page
        • Add Dynamic Configs
        • Run Init Sync on the Tenant
        • Update the pokemonSync flow
        • Run updated Normal Sync on the Tenant
  • Integration Hub
    • Setting Up Source Control
    • Creating An Integration
      • Getting Started with Creating an Integration
      • Demo Video: Creating an Integration With Pandium
    • Managing Internal Integrations
    • Creating a Tenant In the Integration Hub
    • Managing and Updating Tenants
    • Managing and Updating Releases
    • Managing External Integrations
    • Managing Tenant Connection Settings
    • Creating Users
    • Managing Users
    • Administrator Settings
    • Site Metrics
  • Marketplaces
    • Integration Onboarding Experiences Overview
      • Embedding the In-App Marketplace
      • Embedding the Integration Install Only
      • Embedding Auth-Only Connections
    • Customizing the JWT
    • Marketplace Settings
    • App Installation Options
    • Flags, Tags, and Categories
    • Public Gallery
  • Connectors
    • Connectors 101
      • Active Campaign
      • Afterpay
      • AfterShip
      • Airship
      • Alasco
      • Algolia
      • Amadeus
      • Amazon
      • Ankored
      • Apollo.io
      • AppSignal
      • AskNicely
      • Assembled
      • Attentive
      • AWS
      • Azure Devops
      • Azure Personal Access Token
      • Bandcamp
      • Bazaarvoice
      • BigCommerce
      • Bitbucket
      • Booker
      • Box
      • Braze
      • Brightpearl
      • Campaign Monitor
      • Capabl
      • Chargebee
      • Chargify
      • Chubb
      • Cin7
      • Coach Packet
      • ConnectSports
      • Constant Contact
      • Customer Thermometer
      • Datadog
      • Datev
      • Delighted
      • DHL
      • DHL Unified
      • Domo
      • Dotdigital
      • Drip
      • Dropbox
      • Dynamic Yield
      • Easyship
      • Eloqua
      • Emotive
      • Endear
      • Envision
      • eTip
      • EvaluAgent
      • Exact Online
      • eZCom
      • Fabric
      • Facebook
      • Falcon.io
      • Famer
      • Fedex
      • Field Nation
      • Finch
      • Fivetran
      • Fleetio
      • Flowcode
      • Follow Up Boss
      • Fortnox
      • Foundation Software
      • Fulfil
      • GetResponse
      • GitHub
      • GitLab
      • Gladly
      • Google
      • Google Service Account
      • Gooten
      • Gorgias
      • Greenhouse.io
      • Happy Returns
      • HootSuite
      • Hubspot
      • Image Relay (Basic)
      • Imgur
      • Iterable
      • Jasper
      • JDP
      • Justuno
      • Kentico Kontent
      • Klaus
      • Klaviyo
      • Kombo
      • Kustomer
      • kvCORE
      • LeagueApps
      • Lessonly
      • Lexoffice
      • Linga rOS
      • Linnworks
      • Listrak
      • Loop Returns
      • LoyaltyLion
      • Lucid Travel
      • Lytx
      • MaestroQA
      • Magento (OAuth)
      • Mailchimp
      • Marketo
      • Medallia
      • Microsoft Entra
      • Mintsoft
      • NCSA Athletic Recruiting
      • Netomi
      • Netsuite
      • Nicereply
      • Nylas
      • Omnisend
      • OnPay
      • OnRamp
      • Ontraport
      • Optimizely Data Platform (ODP)
      • Pandium
      • Personio
      • PayCom
      • Perspective
      • Player's Health
      • Playvox
      • Pleo
      • Postscript
      • Promoter
      • Quickbooks Online
      • Qualtrics
      • Recart
      • ReCharge
      • Recurly
      • Returnly
      • ReverseLogix
      • Rydership (formerly Whiplash)
      • Sage Intacct
      • SailThru
      • Salesforce
      • Salesforce Marketing Cloud
      • Salesforce Pardot
      • SendGrid
      • Sendlane
      • SevenRooms
      • SFTP
      • ShipBob
      • ShipHero
      • ShipMonk
      • Shippo
      • Shipstation
      • Shopify
      • Skubana
      • Slack (OAuth2)
      • SmartrMail
      • Smartrr
      • Smartvatten
      • Smile.io
      • Solidus
      • Springbig
      • Square
      • Square (Sandbox)
      • Stamped
      • Stella Connect
      • SugarCRM
      • Swell
      • Talkable
      • TeamGenius
      • Tether
      • Thankful
      • TikTok
      • Trinet-B2B Test
      • Triple Whale
      • TrustPilot
      • Twilio
      • Twitter
      • Unbabel
      • UPS
      • Upscribe
      • USPS
      • Visma e-conomic
      • Visma.net
      • Walmart
      • Wix
      • WorkMax
      • Xero (OAuth)
      • Yardstik
      • Yotpo
      • Zendesk (Support)
      • Zingtree
      • Zonos
  • Partners
    • Inviting Partners
    • Partner Form
    • Integration Form
    • Managing Partners
    • Partner User Guide
  • Reference
    • Pandium API
    • Pandium CLI
    • FAQ
    • Sample Integrations
    • Repository Permissions
      • Bitbucket
      • Azure
      • GitLab
      • GitHub
    • Email Support
Powered by GitBook
On this page
  • Notes
  • Installation
  • Authenticate
  • Usage

Was this helpful?

  1. Reference

Pandium CLI

This is a command-line interface that allows developers using Pandium to build, test, and manage integrations directly from their command line while leveraging Pandium’s infrastructure.

Last updated 1 month ago

Was this helpful?

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.

  1. Log into the Pandium Admin Dashboard

  2. Navigate to Settings > Developer Resources

  1. 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.

  1. Paste the command into your terminal and hit “Enter.”

  2. 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)