Overview
Command Line Interface
Learn how to use PandaAI’s command-line interface
PandaAI comes with a command-line interface (CLI) that helps you manage your datasets and authentication.
Authentication
Before using PandaAI’s remote features, you need to authenticate with your API key. Use the login
command:
This will:
- Validate your API key format
- Store it in your
.env
file - Preserve any other environment variables you might have
Dataset Management
Creating a Dataset
Create a new dataset through a guided process:
You’ll be prompted for:
- Dataset path (organization/dataset)
- Dataset name (optional)
- Description (optional)
- Source configuration (type, connection details, etc.)
Pushing a Dataset
Push your local dataset to the remote server:
After pushing, you can access your dataset at: https://app.pandabi.ai/datasets/organization/dataset
Pulling a Dataset
Pull a dataset from the remote server:
Command Reference
Command | Description |
---|---|
login <api-key> | Authenticate with your PandaBI API key |
dataset create | Create a new dataset through a guided process |
push <path> | Push a dataset to the remote server |
pull <path> | Pull a dataset from the remote server |
Path Format
Dataset paths should follow the format: organization/dataset
Examples:
my-org/sales-data
acme-corp/customer-metrics
Requirements:
- Organization and dataset names must be lowercase
- Only hyphens are allowed as separators
- Both organization and dataset names are required
Was this page helpful?