pltr-cli: Palantir Foundry CLI
This skill helps you use the pltr-cli to interact with Palantir Foundry effectively.
Compatibility
- Skill version: 1.1.0
- pltr-cli version: 0.12.0+
- Python: 3.9, 3.10, 3.11, 3.12
- Dependencies: foundry-platform-sdk >= 1.69.0
Overview
pltr-cli is a comprehensive CLI with 100+ commands for:
- Dataset operations: Get info, list files, download files, manage branches and transactions
- SQL queries: Execute queries, export results, manage async queries
- Ontology: List ontologies, object types, objects, execute actions and queries
- Orchestration: Manage builds, jobs, and schedules
- Filesystem: Folders, spaces, projects, resources
- Admin: User, group, role management
- Connectivity: External connections and data imports
- MediaSets: Media file management
- Language Models: Interact with Anthropic Claude models and OpenAI embeddings
- Streams: Create and manage streaming datasets, publish real-time data
- Functions: Execute queries and inspect value types
- AIP Agents: Manage AI agents, sessions, and versions
- Models: ML model registry for model and version management
Critical Concepts
RID-Based API
The Foundry API is RID-based (Resource Identifier). Most commands require RIDs:
- Datasets:
ri.foundry.main.dataset.{uuid}
- Folders:
ri.compass.main.folder.{uuid} (root: ri.compass.main.folder.0)
- Builds:
ri.orchestration.main.build.{uuid}
- Schedules:
ri.orchestration.main.schedule.{uuid}
- Ontologies:
ri.ontology.main.ontology.{uuid}
Users must know RIDs in advance (from Foundry web UI or previous API calls).
Authentication
Before using any command, ensure authentication is configured:
# Configure interactively
pltr configure configure
# Or use environment variables
export FOUNDRY_TOKEN="your-token"
export FOUNDRY_HOST="foundry.company.com"
# Verify connection
pltr verify
Output Formats
All commands support multiple output formats:
pltr <command> --format table # Default: Rich table
pltr <command> --format json # JSON output
pltr <command> --format csv # CSV format
pltr <command> --output file.csv # Save to file
Profile Selection
Use --profile to switch between Foundry instances:
pltr <command> --profile production
pltr <command> --profile development
Reference Files
Load these files based on the user's task:
| Task Type |
Reference File |
| Setup, authentication, getting started |
reference/quick-start.md |
| Dataset operations (get, files, branches, transactions) |
reference/dataset-commands.md |
| SQL queries |
reference/sql-commands.md |
| Builds, jobs, schedules |
reference/orchestration-commands.md |
| Ontologies, objects, actions |
reference/ontology-commands.md |
| Users, groups, roles, orgs |
reference/admin-commands.md |
| Folders, spaces, projects, resources, permissions |
reference/filesystem-commands.md |
| Connections, imports |
reference/connectivity-commands.md |
| Media sets, media items |
reference/mediasets-commands.md |
| Anthropic Claude models, OpenAI embeddings |
reference/language-models-commands.md |
| Streaming datasets, real-time data publishing |
reference/streams-commands.md |
| Functions queries, value types |
reference/functions-commands.md |
| AIP Agents, sessions, versions |
reference/aip-agents-commands.md |
| ML model registry, model versions |
reference/models-commands.md |
Workflow Files
For common multi-step tasks:
| Workflow |
File |
| Data exploration, SQL analysis, ontology queries |
workflows/data-analysis.md |
| ETL pipelines, scheduled jobs, data quality |
workflows/data-pipeline.md |
| Setting up permissions, resource roles, access control |
workflows/permission-management.md |
Common Commands Quick Reference
# Verify setup
pltr verify
# Current user info
pltr admin user current
# Execute SQL query
pltr sql execute "SELECT * FROM my_table LIMIT 10"
# Get dataset info
pltr dataset get ri.foundry.main.dataset.abc123
# List files in dataset
pltr dataset files list ri.foundry.main.dataset.abc123
# Download file from dataset
pltr dataset files get ri.foundry.main.dataset.abc123 "/path/file.csv" "./local.csv"
# Copy dataset to another folder
pltr cp ri.foundry.main.dataset.abc123 ri.compass.main.folder.target456
# List folder contents
pltr folder list ri.compass.main.folder.0 # root folder
# Search builds
pltr orchestration builds search
# Interactive shell mode
pltr shell
# Send message to Claude model
pltr language-models anthropic messages ri.language-models.main.model.xxx \
--message "Explain this concept"
# Generate embeddings
pltr language-models openai embeddings ri.language-models.main.model.xxx \
--input "Sample text"
# Create streaming dataset
pltr streams dataset create my-stream \
--folder ri.compass.main.folder.xxx \
--schema '{"fieldSchemaList": [{"name": "value", "type": "STRING"}]}'
# Publish record to stream
pltr streams stream publish ri.foundry.main.dataset.xxx \
--branch master \
--record '{"value": "hello"}'
# Execute a function query
pltr functions query execute myQuery --parameters '{"limit": 10}'
# Get AIP Agent info
pltr aip-agents get ri.foundry.main.agent.abc123
# List agent sessions
pltr aip-agents sessions list ri.foundry.main.agent.abc123
# Get ML model info
pltr models model get ri.foundry.main.model.abc123
# List model versions
pltr models version list ri.foundry.main.model.abc123
Best Practices
- Always verify authentication first: Run
pltr verify before starting work
- Use appropriate output format: JSON for programmatic use, CSV for spreadsheets, table for readability
- Use async for large queries:
pltr sql submit + pltr sql wait for long-running queries
- Export results: Use
--output to save results for further analysis
- Use shell mode for exploration:
pltr shell provides tab completion and history
Getting Help
pltr --help # All commands
pltr <command> --help # Command help
pltr <command> <sub> --help # Subcommand help
1---2name: pltr-cli3description: "Helps you work with Palantir Foundry using the pltr CLI. Use this when you need to query datasets, manage orchestration builds, work with ontologies, run SQL queries, manage folders/spaces/projects, copy datasets, or perform admin operations in Foundry. Triggers: Foundry, pltr, dataset, SQL query, ontology, build, schedule, RID."4metadata:5 source: https://skillmd.com/skills/dvcrn/pltr-cli6---78# pltr-cli: Palantir Foundry CLI910This skill helps you use the pltr-cli to interact with Palantir Foundry effectively.1112## Compatibility1314- **Skill version**: 1.1.015- **pltr-cli version**: 0.12.0+16- **Python**: 3.9, 3.10, 3.11, 3.1217- **Dependencies**: foundry-platform-sdk >= 1.69.01819## Overview2021pltr-cli is a comprehensive CLI with 100+ commands for:22- **Dataset operations**: Get info, list files, download files, manage branches and transactions23- **SQL queries**: Execute queries, export results, manage async queries24- **Ontology**: List ontologies, object types, objects, execute actions and queries25- **Orchestration**: Manage builds, jobs, and schedules26- **Filesystem**: Folders, spaces, projects, resources27- **Admin**: User, group, role management28- **Connectivity**: External connections and data imports29- **MediaSets**: Media file management30- **Language Models**: Interact with Anthropic Claude models and OpenAI embeddings31- **Streams**: Create and manage streaming datasets, publish real-time data32- **Functions**: Execute queries and inspect value types33- **AIP Agents**: Manage AI agents, sessions, and versions34- **Models**: ML model registry for model and version management3536## Critical Concepts3738### RID-Based API39The Foundry API is **RID-based** (Resource Identifier). Most commands require RIDs:40- **Datasets**: `ri.foundry.main.dataset.{uuid}`41- **Folders**: `ri.compass.main.folder.{uuid}` (root: `ri.compass.main.folder.0`)42- **Builds**: `ri.orchestration.main.build.{uuid}`43- **Schedules**: `ri.orchestration.main.schedule.{uuid}`44- **Ontologies**: `ri.ontology.main.ontology.{uuid}`4546Users must know RIDs in advance (from Foundry web UI or previous API calls).4748### Authentication49Before using any command, ensure authentication is configured:50```bash51# Configure interactively52pltr configure configure5354# Or use environment variables55export FOUNDRY_TOKEN="your-token"56export FOUNDRY_HOST="foundry.company.com"5758# Verify connection59pltr verify60```6162### Output Formats63All commands support multiple output formats:64```bash65pltr <command> --format table # Default: Rich table66pltr <command> --format json # JSON output67pltr <command> --format csv # CSV format68pltr <command> --output file.csv # Save to file69```7071### Profile Selection72Use `--profile` to switch between Foundry instances:73```bash74pltr <command> --profile production75pltr <command> --profile development76```7778## Reference Files7980Load these files based on the user's task:8182| Task Type | Reference File |83|-----------|----------------|84| Setup, authentication, getting started | `reference/quick-start.md` |85| Dataset operations (get, files, branches, transactions) | `reference/dataset-commands.md` |86| SQL queries | `reference/sql-commands.md` |87| Builds, jobs, schedules | `reference/orchestration-commands.md` |88| Ontologies, objects, actions | `reference/ontology-commands.md` |89| Users, groups, roles, orgs | `reference/admin-commands.md` |90| Folders, spaces, projects, resources, permissions | `reference/filesystem-commands.md` |91| Connections, imports | `reference/connectivity-commands.md` |92| Media sets, media items | `reference/mediasets-commands.md` |93| Anthropic Claude models, OpenAI embeddings | `reference/language-models-commands.md` |94| Streaming datasets, real-time data publishing | `reference/streams-commands.md` |95| Functions queries, value types | `reference/functions-commands.md` |96| AIP Agents, sessions, versions | `reference/aip-agents-commands.md` |97| ML model registry, model versions | `reference/models-commands.md` |9899## Workflow Files100101For common multi-step tasks:102103| Workflow | File |104|----------|------|105| Data exploration, SQL analysis, ontology queries | `workflows/data-analysis.md` |106| ETL pipelines, scheduled jobs, data quality | `workflows/data-pipeline.md` |107| Setting up permissions, resource roles, access control | `workflows/permission-management.md` |108109## Common Commands Quick Reference110111```bash112# Verify setup113pltr verify114115# Current user info116pltr admin user current117118# Execute SQL query119pltr sql execute "SELECT * FROM my_table LIMIT 10"120121# Get dataset info122pltr dataset get ri.foundry.main.dataset.abc123123124# List files in dataset125pltr dataset files list ri.foundry.main.dataset.abc123126127# Download file from dataset128pltr dataset files get ri.foundry.main.dataset.abc123 "/path/file.csv" "./local.csv"129130# Copy dataset to another folder131pltr cp ri.foundry.main.dataset.abc123 ri.compass.main.folder.target456132133# List folder contents134pltr folder list ri.compass.main.folder.0 # root folder135136# Search builds137pltr orchestration builds search138139# Interactive shell mode140pltr shell141142# Send message to Claude model143pltr language-models anthropic messages ri.language-models.main.model.xxx \144 --message "Explain this concept"145146# Generate embeddings147pltr language-models openai embeddings ri.language-models.main.model.xxx \148 --input "Sample text"149150# Create streaming dataset151pltr streams dataset create my-stream \152 --folder ri.compass.main.folder.xxx \153 --schema '{"fieldSchemaList": [{"name": "value", "type": "STRING"}]}'154155# Publish record to stream156pltr streams stream publish ri.foundry.main.dataset.xxx \157 --branch master \158 --record '{"value": "hello"}'159160# Execute a function query161pltr functions query execute myQuery --parameters '{"limit": 10}'162163# Get AIP Agent info164pltr aip-agents get ri.foundry.main.agent.abc123165166# List agent sessions167pltr aip-agents sessions list ri.foundry.main.agent.abc123168169# Get ML model info170pltr models model get ri.foundry.main.model.abc123171172# List model versions173pltr models version list ri.foundry.main.model.abc123174```175176## Best Practices1771781. **Always verify authentication first**: Run `pltr verify` before starting work1792. **Use appropriate output format**: JSON for programmatic use, CSV for spreadsheets, table for readability1803. **Use async for large queries**: `pltr sql submit` + `pltr sql wait` for long-running queries1814. **Export results**: Use `--output` to save results for further analysis1825. **Use shell mode for exploration**: `pltr shell` provides tab completion and history183184## Getting Help185186```bash187pltr --help # All commands188pltr <command> --help # Command help189pltr <command> <sub> --help # Subcommand help190```