pltr-cli 0.3.0__tar.gz → 0.5.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- pltr_cli-0.5.0/CHANGELOG.md +26 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/CLAUDE.md +0 -1
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/PKG-INFO +139 -5
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/README.md +138 -4
- pltr_cli-0.5.0/children.csv +3 -0
- pltr_cli-0.5.0/docs/user-guide/commands.md +1295 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/docs/user-guide/quick-start.md +9 -3
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/docs/user-guide/workflows.md +85 -0
- pltr_cli-0.5.0/folder_info.json +9 -0
- pltr_cli-0.5.0/folders.json +11 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/pyproject.toml +1 -1
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/cli.py +10 -0
- pltr_cli-0.5.0/src/pltr/commands/dataset.py +424 -0
- pltr_cli-0.5.0/src/pltr/commands/folder.py +338 -0
- pltr_cli-0.5.0/src/pltr/commands/mediasets.py +422 -0
- pltr_cli-0.5.0/src/pltr/commands/orchestration.py +642 -0
- pltr_cli-0.3.0/src/pltr/services/dataset_full.py → pltr_cli-0.5.0/src/pltr/services/dataset.py +147 -1
- pltr_cli-0.5.0/src/pltr/services/folder.py +167 -0
- pltr_cli-0.5.0/src/pltr/services/mediasets.py +293 -0
- pltr_cli-0.5.0/src/pltr/services/orchestration.py +457 -0
- pltr_cli-0.5.0/src/pltr/utils/formatting.py +1177 -0
- pltr_cli-0.5.0/tests/test_commands/test_folder.py +348 -0
- pltr_cli-0.5.0/tests/test_commands/test_orchestration.py +450 -0
- pltr_cli-0.5.0/tests/test_services/test_folder.py +262 -0
- pltr_cli-0.5.0/tests/test_services/test_orchestration.py +423 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/uv.lock +1 -1
- pltr_cli-0.3.0/docs/user-guide/commands.md +0 -614
- pltr_cli-0.3.0/src/pltr/commands/dataset.py +0 -115
- pltr_cli-0.3.0/src/pltr/services/dataset.py +0 -90
- pltr_cli-0.3.0/src/pltr/services/dataset_v2.py +0 -128
- pltr_cli-0.3.0/src/pltr/utils/formatting.py +0 -539
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/.github/workflows/ci.yml +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/.github/workflows/publish.yml +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/.github/workflows/test-publish.yml +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/.gitignore +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/.pre-commit-config.yaml +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/LICENSE +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/docs/README.md +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/docs/api/wrapper.md +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/docs/examples/gallery.md +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/docs/user-guide/aliases.md +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/docs/user-guide/authentication.md +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/docs/user-guide/troubleshooting.md +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/mypy.ini +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/scripts/release.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/__init__.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/__main__.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/auth/__init__.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/auth/base.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/auth/manager.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/auth/oauth.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/auth/storage.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/auth/token.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/commands/__init__.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/commands/admin.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/commands/alias.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/commands/completion.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/commands/configure.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/commands/ontology.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/commands/shell.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/commands/sql.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/commands/verify.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/config/__init__.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/config/aliases.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/config/profiles.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/config/settings.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/services/__init__.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/services/admin.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/services/base.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/services/ontology.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/services/sql.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/utils/__init__.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/utils/alias_resolver.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/utils/completion.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/src/pltr/utils/progress.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/__init__.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/conftest.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/integration/README.md +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/integration/__init__.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/integration/conftest.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/integration/test_auth_flow.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/integration/test_cli_integration.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/integration/test_data_workflows.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/integration/test_data_workflows_simple.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/integration/test_simple_integration.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_auth/__init__.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_auth/test_base.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_auth/test_manager.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_auth/test_oauth.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_auth/test_storage.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_auth/test_token.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_commands/__init__.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_commands/test_admin.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_commands/test_alias.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_commands/test_completion.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_commands/test_dataset.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_commands/test_ontology.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_commands/test_shell.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_commands/test_sql.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_commands/test_verify_simple.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_config/__init__.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_config/test_aliases.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_config/test_profiles.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_config/test_settings.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_services/__init__.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_services/test_admin.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_services/test_base.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_services/test_dataset.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_services/test_ontology.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_services/test_sql.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_utils/__init__.py +0 -0
- {pltr_cli-0.3.0 → pltr_cli-0.5.0}/tests/test_utils/test_alias_resolver.py +0 -0
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
All notable changes to this project will be documented in this file.
|
|
4
|
+
|
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
|
+
|
|
8
|
+
## [0.4.0] - 2025-01-31
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
- Comprehensive folder management functionality
|
|
12
|
+
- Preview mode support for folder API operations
|
|
13
|
+
|
|
14
|
+
### Fixed
|
|
15
|
+
- CI pipeline issues
|
|
16
|
+
- Code style and formatting improvements
|
|
17
|
+
|
|
18
|
+
## [0.3.0] - 2024-12-XX
|
|
19
|
+
|
|
20
|
+
### Added
|
|
21
|
+
- Initial release with core CLI functionality
|
|
22
|
+
- Palantir Foundry API integration
|
|
23
|
+
- Command-line interface for data operations
|
|
24
|
+
|
|
25
|
+
[0.4.0]: https://github.com/anjor/pltr-cli/compare/v0.3.0...v0.4.0
|
|
26
|
+
[0.3.0]: https://github.com/anjor/pltr-cli/releases/tag/v0.3.0
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: pltr-cli
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.5.0
|
|
4
4
|
Summary: Command-line interface for Palantir Foundry APIs
|
|
5
5
|
Project-URL: Homepage, https://github.com/anjor/pltr-cli
|
|
6
6
|
Project-URL: Repository, https://github.com/anjor/pltr-cli
|
|
@@ -37,7 +37,7 @@ Description-Content-Type: text/markdown
|
|
|
37
37
|
|
|
38
38
|
# pltr-cli
|
|
39
39
|
|
|
40
|
-
A comprehensive command-line interface for Palantir Foundry APIs, providing
|
|
40
|
+
A comprehensive command-line interface for Palantir Foundry APIs, providing 80+ commands for data analysis, dataset management, ontology operations, orchestration, SQL queries, folder management, and administrative tasks.
|
|
41
41
|
|
|
42
42
|
## Overview
|
|
43
43
|
|
|
@@ -46,8 +46,11 @@ A comprehensive command-line interface for Palantir Foundry APIs, providing 65+
|
|
|
46
46
|
## ✨ Key Features
|
|
47
47
|
|
|
48
48
|
- 🔐 **Secure Authentication**: Token and OAuth2 support with encrypted credential storage
|
|
49
|
-
- 📊 **Dataset Operations**:
|
|
49
|
+
- 📊 **Dataset Operations**: Complete dataset management with branches, files, transactions, and views (RID-based API)
|
|
50
|
+
- 📁 **Folder Management**: Create, explore, and manage Foundry filesystem structure
|
|
50
51
|
- 🎯 **Comprehensive Ontology Access**: 13 commands for objects, actions, and queries
|
|
52
|
+
- 🏗️ **Orchestration Management**: Create, manage, and monitor builds, jobs, and schedules
|
|
53
|
+
- 🎬 **MediaSets Operations**: Upload, download, and manage media content with transaction support
|
|
51
54
|
- 📝 **Full SQL Support**: Execute, submit, monitor, and export query results
|
|
52
55
|
- 👥 **Admin Operations**: User, group, role, and organization management (16 commands)
|
|
53
56
|
- 💻 **Interactive Shell**: REPL mode with tab completion and command history
|
|
@@ -109,9 +112,23 @@ pltr admin user current
|
|
|
109
112
|
# List available ontologies
|
|
110
113
|
pltr ontology list
|
|
111
114
|
|
|
115
|
+
# Search for builds
|
|
116
|
+
pltr orchestration builds search
|
|
117
|
+
|
|
118
|
+
# Create a new folder
|
|
119
|
+
pltr folder create "My Project"
|
|
120
|
+
|
|
121
|
+
# List root folder contents
|
|
122
|
+
pltr folder list ri.compass.main.folder.0
|
|
123
|
+
|
|
112
124
|
# Execute a simple SQL query
|
|
113
125
|
pltr sql execute "SELECT 1 as test"
|
|
114
126
|
|
|
127
|
+
# Explore dataset operations (requires dataset RID)
|
|
128
|
+
pltr dataset get ri.foundry.main.dataset.abc123
|
|
129
|
+
pltr dataset branches list ri.foundry.main.dataset.abc123
|
|
130
|
+
pltr dataset files list ri.foundry.main.dataset.abc123
|
|
131
|
+
|
|
115
132
|
# Start interactive mode for exploration
|
|
116
133
|
pltr shell
|
|
117
134
|
```
|
|
@@ -133,7 +150,7 @@ pltr-cli provides comprehensive documentation to help you get the most out of th
|
|
|
133
150
|
### 📖 User Guides
|
|
134
151
|
- **[Quick Start Guide](docs/user-guide/quick-start.md)** - Get up and running in 5 minutes
|
|
135
152
|
- **[Authentication Setup](docs/user-guide/authentication.md)** - Complete guide to token and OAuth2 setup
|
|
136
|
-
- **[Command Reference](docs/user-guide/commands.md)** - Complete reference for all
|
|
153
|
+
- **[Command Reference](docs/user-guide/commands.md)** - Complete reference for all 70+ commands
|
|
137
154
|
- **[Common Workflows](docs/user-guide/workflows.md)** - Real-world data analysis patterns
|
|
138
155
|
- **[Troubleshooting](docs/user-guide/troubleshooting.md)** - Solutions to common issues
|
|
139
156
|
|
|
@@ -154,6 +171,16 @@ pltr sql execute "SELECT * FROM table" # Run SQL queries
|
|
|
154
171
|
pltr ontology list # List ontologies
|
|
155
172
|
pltr dataset get <rid> # Get dataset info
|
|
156
173
|
|
|
174
|
+
# Orchestration
|
|
175
|
+
pltr orchestration builds search # Search builds
|
|
176
|
+
pltr orchestration jobs get <job-rid> # Get job details
|
|
177
|
+
pltr orchestration schedules create # Create schedule
|
|
178
|
+
|
|
179
|
+
# MediaSets
|
|
180
|
+
pltr media-sets get <set-rid> <item-rid> # Get media item info
|
|
181
|
+
pltr media-sets upload <set-rid> file.jpg "/path/file.jpg" <txn-id> # Upload media
|
|
182
|
+
pltr media-sets download <set-rid> <item-rid> output.jpg # Download media
|
|
183
|
+
|
|
157
184
|
# Administrative
|
|
158
185
|
pltr admin user current # Current user info
|
|
159
186
|
pltr admin user list # List users
|
|
@@ -167,6 +194,113 @@ pltr completion install # Enable tab completion
|
|
|
167
194
|
|
|
168
195
|
For the complete command reference with examples, see **[Command Reference](docs/user-guide/commands.md)**.
|
|
169
196
|
|
|
197
|
+
### 🏗️ Orchestration Commands
|
|
198
|
+
|
|
199
|
+
pltr-cli provides comprehensive support for Foundry's Orchestration module:
|
|
200
|
+
|
|
201
|
+
#### Build Management
|
|
202
|
+
```bash
|
|
203
|
+
# Search for builds
|
|
204
|
+
pltr orchestration builds search
|
|
205
|
+
|
|
206
|
+
# Get build details
|
|
207
|
+
pltr orchestration builds get ri.orchestration.main.build.12345
|
|
208
|
+
|
|
209
|
+
# Create a new build
|
|
210
|
+
pltr orchestration builds create '{"dataset_rid": "ri.foundry.main.dataset.abc"}' --branch main
|
|
211
|
+
|
|
212
|
+
# Cancel a running build
|
|
213
|
+
pltr orchestration builds cancel ri.orchestration.main.build.12345
|
|
214
|
+
|
|
215
|
+
# List jobs in a build
|
|
216
|
+
pltr orchestration builds jobs ri.orchestration.main.build.12345
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
#### Job Management
|
|
220
|
+
```bash
|
|
221
|
+
# Get job details
|
|
222
|
+
pltr orchestration jobs get ri.orchestration.main.job.12345
|
|
223
|
+
|
|
224
|
+
# Get multiple jobs in batch
|
|
225
|
+
pltr orchestration jobs get-batch "rid1,rid2,rid3"
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
#### Schedule Management
|
|
229
|
+
```bash
|
|
230
|
+
# Get schedule information
|
|
231
|
+
pltr orchestration schedules get ri.orchestration.main.schedule.12345
|
|
232
|
+
|
|
233
|
+
# Create a new schedule
|
|
234
|
+
pltr orchestration schedules create '{"type": "BUILD", "target": "dataset-rid"}' \
|
|
235
|
+
--name "Daily Build" --description "Automated daily build"
|
|
236
|
+
|
|
237
|
+
# Pause/unpause schedules
|
|
238
|
+
pltr orchestration schedules pause ri.orchestration.main.schedule.12345
|
|
239
|
+
pltr orchestration schedules unpause ri.orchestration.main.schedule.12345
|
|
240
|
+
|
|
241
|
+
# Execute schedule immediately
|
|
242
|
+
pltr orchestration schedules run ri.orchestration.main.schedule.12345
|
|
243
|
+
|
|
244
|
+
# Delete a schedule
|
|
245
|
+
pltr orchestration schedules delete ri.orchestration.main.schedule.12345 --yes
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
**All orchestration commands support:**
|
|
249
|
+
- Multiple output formats (table, JSON, CSV)
|
|
250
|
+
- File output (`--output filename`)
|
|
251
|
+
- Profile selection (`--profile production`)
|
|
252
|
+
- Preview mode for schedules (`--preview`)
|
|
253
|
+
|
|
254
|
+
### 🎬 MediaSets Commands
|
|
255
|
+
|
|
256
|
+
pltr-cli provides full support for Foundry's MediaSets module for managing media content:
|
|
257
|
+
|
|
258
|
+
#### Media Item Operations
|
|
259
|
+
```bash
|
|
260
|
+
# Get media item information
|
|
261
|
+
pltr media-sets get ri.mediasets.main.media-set.abc ri.mediasets.main.media-item.123
|
|
262
|
+
|
|
263
|
+
# Get media item RID by path
|
|
264
|
+
pltr media-sets get-by-path ri.mediasets.main.media-set.abc "/images/photo.jpg"
|
|
265
|
+
|
|
266
|
+
# Get a reference for embedding
|
|
267
|
+
pltr media-sets reference ri.mediasets.main.media-set.abc ri.mediasets.main.media-item.123
|
|
268
|
+
```
|
|
269
|
+
|
|
270
|
+
#### Transaction Management
|
|
271
|
+
```bash
|
|
272
|
+
# Create a new upload transaction
|
|
273
|
+
pltr media-sets create ri.mediasets.main.media-set.abc --branch main
|
|
274
|
+
|
|
275
|
+
# Commit transaction (makes uploads available)
|
|
276
|
+
pltr media-sets commit ri.mediasets.main.media-set.abc transaction-id-12345
|
|
277
|
+
|
|
278
|
+
# Abort transaction (deletes uploads)
|
|
279
|
+
pltr media-sets abort ri.mediasets.main.media-set.abc transaction-id-12345 --yes
|
|
280
|
+
```
|
|
281
|
+
|
|
282
|
+
#### Upload and Download
|
|
283
|
+
```bash
|
|
284
|
+
# Upload a file to media set
|
|
285
|
+
pltr media-sets upload ri.mediasets.main.media-set.abc \
|
|
286
|
+
/local/path/image.jpg "/media/images/image.jpg" transaction-id-12345
|
|
287
|
+
|
|
288
|
+
# Download media item (processed version)
|
|
289
|
+
pltr media-sets download ri.mediasets.main.media-set.abc \
|
|
290
|
+
ri.mediasets.main.media-item.123 /local/download/image.jpg
|
|
291
|
+
|
|
292
|
+
# Download original version
|
|
293
|
+
pltr media-sets download ri.mediasets.main.media-set.abc \
|
|
294
|
+
ri.mediasets.main.media-item.123 /local/download/original.jpg --original
|
|
295
|
+
```
|
|
296
|
+
|
|
297
|
+
**All MediaSets commands support:**
|
|
298
|
+
- Multiple output formats (table, JSON, CSV)
|
|
299
|
+
- File output (`--output filename`)
|
|
300
|
+
- Profile selection (`--profile production`)
|
|
301
|
+
- Preview mode (`--preview`)
|
|
302
|
+
- Transaction-based upload workflow
|
|
303
|
+
|
|
170
304
|
## ⚙️ Configuration
|
|
171
305
|
|
|
172
306
|
pltr-cli stores configuration securely using industry best practices:
|
|
@@ -237,7 +371,7 @@ See **[API Wrapper Documentation](docs/api/wrapper.md)** for detailed architectu
|
|
|
237
371
|
|
|
238
372
|
pltr-cli is **production-ready** with comprehensive features:
|
|
239
373
|
|
|
240
|
-
- ✅ **
|
|
374
|
+
- ✅ **80+ Commands** across 10 command groups
|
|
241
375
|
- ✅ **273 Unit Tests** with 67% code coverage
|
|
242
376
|
- ✅ **Published on PyPI** with automated releases
|
|
243
377
|
- ✅ **Cross-Platform** support (Windows, macOS, Linux)
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# pltr-cli
|
|
2
2
|
|
|
3
|
-
A comprehensive command-line interface for Palantir Foundry APIs, providing
|
|
3
|
+
A comprehensive command-line interface for Palantir Foundry APIs, providing 80+ commands for data analysis, dataset management, ontology operations, orchestration, SQL queries, folder management, and administrative tasks.
|
|
4
4
|
|
|
5
5
|
## Overview
|
|
6
6
|
|
|
@@ -9,8 +9,11 @@ A comprehensive command-line interface for Palantir Foundry APIs, providing 65+
|
|
|
9
9
|
## ✨ Key Features
|
|
10
10
|
|
|
11
11
|
- 🔐 **Secure Authentication**: Token and OAuth2 support with encrypted credential storage
|
|
12
|
-
- 📊 **Dataset Operations**:
|
|
12
|
+
- 📊 **Dataset Operations**: Complete dataset management with branches, files, transactions, and views (RID-based API)
|
|
13
|
+
- 📁 **Folder Management**: Create, explore, and manage Foundry filesystem structure
|
|
13
14
|
- 🎯 **Comprehensive Ontology Access**: 13 commands for objects, actions, and queries
|
|
15
|
+
- 🏗️ **Orchestration Management**: Create, manage, and monitor builds, jobs, and schedules
|
|
16
|
+
- 🎬 **MediaSets Operations**: Upload, download, and manage media content with transaction support
|
|
14
17
|
- 📝 **Full SQL Support**: Execute, submit, monitor, and export query results
|
|
15
18
|
- 👥 **Admin Operations**: User, group, role, and organization management (16 commands)
|
|
16
19
|
- 💻 **Interactive Shell**: REPL mode with tab completion and command history
|
|
@@ -72,9 +75,23 @@ pltr admin user current
|
|
|
72
75
|
# List available ontologies
|
|
73
76
|
pltr ontology list
|
|
74
77
|
|
|
78
|
+
# Search for builds
|
|
79
|
+
pltr orchestration builds search
|
|
80
|
+
|
|
81
|
+
# Create a new folder
|
|
82
|
+
pltr folder create "My Project"
|
|
83
|
+
|
|
84
|
+
# List root folder contents
|
|
85
|
+
pltr folder list ri.compass.main.folder.0
|
|
86
|
+
|
|
75
87
|
# Execute a simple SQL query
|
|
76
88
|
pltr sql execute "SELECT 1 as test"
|
|
77
89
|
|
|
90
|
+
# Explore dataset operations (requires dataset RID)
|
|
91
|
+
pltr dataset get ri.foundry.main.dataset.abc123
|
|
92
|
+
pltr dataset branches list ri.foundry.main.dataset.abc123
|
|
93
|
+
pltr dataset files list ri.foundry.main.dataset.abc123
|
|
94
|
+
|
|
78
95
|
# Start interactive mode for exploration
|
|
79
96
|
pltr shell
|
|
80
97
|
```
|
|
@@ -96,7 +113,7 @@ pltr-cli provides comprehensive documentation to help you get the most out of th
|
|
|
96
113
|
### 📖 User Guides
|
|
97
114
|
- **[Quick Start Guide](docs/user-guide/quick-start.md)** - Get up and running in 5 minutes
|
|
98
115
|
- **[Authentication Setup](docs/user-guide/authentication.md)** - Complete guide to token and OAuth2 setup
|
|
99
|
-
- **[Command Reference](docs/user-guide/commands.md)** - Complete reference for all
|
|
116
|
+
- **[Command Reference](docs/user-guide/commands.md)** - Complete reference for all 70+ commands
|
|
100
117
|
- **[Common Workflows](docs/user-guide/workflows.md)** - Real-world data analysis patterns
|
|
101
118
|
- **[Troubleshooting](docs/user-guide/troubleshooting.md)** - Solutions to common issues
|
|
102
119
|
|
|
@@ -117,6 +134,16 @@ pltr sql execute "SELECT * FROM table" # Run SQL queries
|
|
|
117
134
|
pltr ontology list # List ontologies
|
|
118
135
|
pltr dataset get <rid> # Get dataset info
|
|
119
136
|
|
|
137
|
+
# Orchestration
|
|
138
|
+
pltr orchestration builds search # Search builds
|
|
139
|
+
pltr orchestration jobs get <job-rid> # Get job details
|
|
140
|
+
pltr orchestration schedules create # Create schedule
|
|
141
|
+
|
|
142
|
+
# MediaSets
|
|
143
|
+
pltr media-sets get <set-rid> <item-rid> # Get media item info
|
|
144
|
+
pltr media-sets upload <set-rid> file.jpg "/path/file.jpg" <txn-id> # Upload media
|
|
145
|
+
pltr media-sets download <set-rid> <item-rid> output.jpg # Download media
|
|
146
|
+
|
|
120
147
|
# Administrative
|
|
121
148
|
pltr admin user current # Current user info
|
|
122
149
|
pltr admin user list # List users
|
|
@@ -130,6 +157,113 @@ pltr completion install # Enable tab completion
|
|
|
130
157
|
|
|
131
158
|
For the complete command reference with examples, see **[Command Reference](docs/user-guide/commands.md)**.
|
|
132
159
|
|
|
160
|
+
### 🏗️ Orchestration Commands
|
|
161
|
+
|
|
162
|
+
pltr-cli provides comprehensive support for Foundry's Orchestration module:
|
|
163
|
+
|
|
164
|
+
#### Build Management
|
|
165
|
+
```bash
|
|
166
|
+
# Search for builds
|
|
167
|
+
pltr orchestration builds search
|
|
168
|
+
|
|
169
|
+
# Get build details
|
|
170
|
+
pltr orchestration builds get ri.orchestration.main.build.12345
|
|
171
|
+
|
|
172
|
+
# Create a new build
|
|
173
|
+
pltr orchestration builds create '{"dataset_rid": "ri.foundry.main.dataset.abc"}' --branch main
|
|
174
|
+
|
|
175
|
+
# Cancel a running build
|
|
176
|
+
pltr orchestration builds cancel ri.orchestration.main.build.12345
|
|
177
|
+
|
|
178
|
+
# List jobs in a build
|
|
179
|
+
pltr orchestration builds jobs ri.orchestration.main.build.12345
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
#### Job Management
|
|
183
|
+
```bash
|
|
184
|
+
# Get job details
|
|
185
|
+
pltr orchestration jobs get ri.orchestration.main.job.12345
|
|
186
|
+
|
|
187
|
+
# Get multiple jobs in batch
|
|
188
|
+
pltr orchestration jobs get-batch "rid1,rid2,rid3"
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
#### Schedule Management
|
|
192
|
+
```bash
|
|
193
|
+
# Get schedule information
|
|
194
|
+
pltr orchestration schedules get ri.orchestration.main.schedule.12345
|
|
195
|
+
|
|
196
|
+
# Create a new schedule
|
|
197
|
+
pltr orchestration schedules create '{"type": "BUILD", "target": "dataset-rid"}' \
|
|
198
|
+
--name "Daily Build" --description "Automated daily build"
|
|
199
|
+
|
|
200
|
+
# Pause/unpause schedules
|
|
201
|
+
pltr orchestration schedules pause ri.orchestration.main.schedule.12345
|
|
202
|
+
pltr orchestration schedules unpause ri.orchestration.main.schedule.12345
|
|
203
|
+
|
|
204
|
+
# Execute schedule immediately
|
|
205
|
+
pltr orchestration schedules run ri.orchestration.main.schedule.12345
|
|
206
|
+
|
|
207
|
+
# Delete a schedule
|
|
208
|
+
pltr orchestration schedules delete ri.orchestration.main.schedule.12345 --yes
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
**All orchestration commands support:**
|
|
212
|
+
- Multiple output formats (table, JSON, CSV)
|
|
213
|
+
- File output (`--output filename`)
|
|
214
|
+
- Profile selection (`--profile production`)
|
|
215
|
+
- Preview mode for schedules (`--preview`)
|
|
216
|
+
|
|
217
|
+
### 🎬 MediaSets Commands
|
|
218
|
+
|
|
219
|
+
pltr-cli provides full support for Foundry's MediaSets module for managing media content:
|
|
220
|
+
|
|
221
|
+
#### Media Item Operations
|
|
222
|
+
```bash
|
|
223
|
+
# Get media item information
|
|
224
|
+
pltr media-sets get ri.mediasets.main.media-set.abc ri.mediasets.main.media-item.123
|
|
225
|
+
|
|
226
|
+
# Get media item RID by path
|
|
227
|
+
pltr media-sets get-by-path ri.mediasets.main.media-set.abc "/images/photo.jpg"
|
|
228
|
+
|
|
229
|
+
# Get a reference for embedding
|
|
230
|
+
pltr media-sets reference ri.mediasets.main.media-set.abc ri.mediasets.main.media-item.123
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
#### Transaction Management
|
|
234
|
+
```bash
|
|
235
|
+
# Create a new upload transaction
|
|
236
|
+
pltr media-sets create ri.mediasets.main.media-set.abc --branch main
|
|
237
|
+
|
|
238
|
+
# Commit transaction (makes uploads available)
|
|
239
|
+
pltr media-sets commit ri.mediasets.main.media-set.abc transaction-id-12345
|
|
240
|
+
|
|
241
|
+
# Abort transaction (deletes uploads)
|
|
242
|
+
pltr media-sets abort ri.mediasets.main.media-set.abc transaction-id-12345 --yes
|
|
243
|
+
```
|
|
244
|
+
|
|
245
|
+
#### Upload and Download
|
|
246
|
+
```bash
|
|
247
|
+
# Upload a file to media set
|
|
248
|
+
pltr media-sets upload ri.mediasets.main.media-set.abc \
|
|
249
|
+
/local/path/image.jpg "/media/images/image.jpg" transaction-id-12345
|
|
250
|
+
|
|
251
|
+
# Download media item (processed version)
|
|
252
|
+
pltr media-sets download ri.mediasets.main.media-set.abc \
|
|
253
|
+
ri.mediasets.main.media-item.123 /local/download/image.jpg
|
|
254
|
+
|
|
255
|
+
# Download original version
|
|
256
|
+
pltr media-sets download ri.mediasets.main.media-set.abc \
|
|
257
|
+
ri.mediasets.main.media-item.123 /local/download/original.jpg --original
|
|
258
|
+
```
|
|
259
|
+
|
|
260
|
+
**All MediaSets commands support:**
|
|
261
|
+
- Multiple output formats (table, JSON, CSV)
|
|
262
|
+
- File output (`--output filename`)
|
|
263
|
+
- Profile selection (`--profile production`)
|
|
264
|
+
- Preview mode (`--preview`)
|
|
265
|
+
- Transaction-based upload workflow
|
|
266
|
+
|
|
133
267
|
## ⚙️ Configuration
|
|
134
268
|
|
|
135
269
|
pltr-cli stores configuration securely using industry best practices:
|
|
@@ -200,7 +334,7 @@ See **[API Wrapper Documentation](docs/api/wrapper.md)** for detailed architectu
|
|
|
200
334
|
|
|
201
335
|
pltr-cli is **production-ready** with comprehensive features:
|
|
202
336
|
|
|
203
|
-
- ✅ **
|
|
337
|
+
- ✅ **80+ Commands** across 10 command groups
|
|
204
338
|
- ✅ **273 Unit Tests** with 67% code coverage
|
|
205
339
|
- ✅ **Published on PyPI** with automated releases
|
|
206
340
|
- ✅ **Cross-Platform** support (Windows, macOS, Linux)
|