pltr-cli 0.2.0__tar.gz → 0.4.0__tar.gz

pltr_cli-0.4.0/CHANGELOG.md

@@ -0,0 +1,26 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.4.0] - 2025-01-31
+
+### Added
+- Comprehensive folder management functionality
+- Preview mode support for folder API operations
+
+### Fixed
+- CI pipeline issues
+- Code style and formatting improvements
+
+## [0.3.0] - 2024-12-XX
+
+### Added
+- Initial release with core CLI functionality
+- Palantir Foundry API integration
+- Command-line interface for data operations
+
+[0.4.0]: https://github.com/anjor/pltr-cli/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/anjor/pltr-cli/releases/tag/v0.3.0

{pltr_cli-0.2.0 → pltr_cli-0.4.0}/CLAUDE.md

@@ -1,6 +1,5 @@
 ## Development tips
 
-Always keep @DEVELOPMENT_PLAN.md up to date.
 The basis of the SDK is https://github.com/palantir/foundry-platform-python . This is a
 CLI that wraps around the SDK to give a CLI interface.
 

{pltr_cli-0.2.0 → pltr_cli-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pltr-cli
-Version: 0.2.0
+Version: 0.4.0
 Summary: Command-line interface for Palantir Foundry APIs
 Project-URL: Homepage, https://github.com/anjor/pltr-cli
 Project-URL: Repository, https://github.com/anjor/pltr-cli
@@ -37,7 +37,7 @@ Description-Content-Type: text/markdown
 
 # pltr-cli
 
-A comprehensive command-line interface for Palantir Foundry APIs, providing 65+ commands for data analysis, ontology operations, SQL queries, and administrative tasks.
+A comprehensive command-line interface for Palantir Foundry APIs, providing 70+ commands for data analysis, ontology operations, SQL queries, folder management, and administrative tasks.
 
 ## Overview
 
@@ -47,6 +47,7 @@ A comprehensive command-line interface for Palantir Foundry APIs, providing 65+
 
 - 🔐 **Secure Authentication**: Token and OAuth2 support with encrypted credential storage
 - 📊 **Dataset Operations**: Get dataset information and create new datasets (RID-based API)
+- 📁 **Folder Management**: Create, explore, and manage Foundry filesystem structure
 - 🎯 **Comprehensive Ontology Access**: 13 commands for objects, actions, and queries
 - 📝 **Full SQL Support**: Execute, submit, monitor, and export query results
 - 👥 **Admin Operations**: User, group, role, and organization management (16 commands)
@@ -109,6 +110,12 @@ pltr admin user current
 # List available ontologies
 pltr ontology list
 
+# Create a new folder
+pltr folder create "My Project"
+
+# List root folder contents
+pltr folder list ri.compass.main.folder.0
+
 # Execute a simple SQL query
 pltr sql execute "SELECT 1 as test"
 
@@ -133,7 +140,7 @@ pltr-cli provides comprehensive documentation to help you get the most out of th
 ### 📖 User Guides
 - **[Quick Start Guide](docs/user-guide/quick-start.md)** - Get up and running in 5 minutes
 - **[Authentication Setup](docs/user-guide/authentication.md)** - Complete guide to token and OAuth2 setup
-- **[Command Reference](docs/user-guide/commands.md)** - Complete reference for all 65+ commands
+- **[Command Reference](docs/user-guide/commands.md)** - Complete reference for all 70+ commands
 - **[Common Workflows](docs/user-guide/workflows.md)** - Real-world data analysis patterns
 - **[Troubleshooting](docs/user-guide/troubleshooting.md)** - Solutions to common issues
 

{pltr_cli-0.2.0 → pltr_cli-0.4.0}/README.md

@@ -1,6 +1,6 @@
 # pltr-cli
 
-A comprehensive command-line interface for Palantir Foundry APIs, providing 65+ commands for data analysis, ontology operations, SQL queries, and administrative tasks.
+A comprehensive command-line interface for Palantir Foundry APIs, providing 70+ commands for data analysis, ontology operations, SQL queries, folder management, and administrative tasks.
 
 ## Overview
 
@@ -10,6 +10,7 @@ A comprehensive command-line interface for Palantir Foundry APIs, providing 65+
 
 - 🔐 **Secure Authentication**: Token and OAuth2 support with encrypted credential storage
 - 📊 **Dataset Operations**: Get dataset information and create new datasets (RID-based API)
+- 📁 **Folder Management**: Create, explore, and manage Foundry filesystem structure
 - 🎯 **Comprehensive Ontology Access**: 13 commands for objects, actions, and queries
 - 📝 **Full SQL Support**: Execute, submit, monitor, and export query results
 - 👥 **Admin Operations**: User, group, role, and organization management (16 commands)
@@ -72,6 +73,12 @@ pltr admin user current
 # List available ontologies
 pltr ontology list
 
+# Create a new folder
+pltr folder create "My Project"
+
+# List root folder contents
+pltr folder list ri.compass.main.folder.0
+
 # Execute a simple SQL query
 pltr sql execute "SELECT 1 as test"
 
@@ -96,7 +103,7 @@ pltr-cli provides comprehensive documentation to help you get the most out of th
 ### 📖 User Guides
 - **[Quick Start Guide](docs/user-guide/quick-start.md)** - Get up and running in 5 minutes
 - **[Authentication Setup](docs/user-guide/authentication.md)** - Complete guide to token and OAuth2 setup
-- **[Command Reference](docs/user-guide/commands.md)** - Complete reference for all 65+ commands
+- **[Command Reference](docs/user-guide/commands.md)** - Complete reference for all 70+ commands
 - **[Common Workflows](docs/user-guide/workflows.md)** - Real-world data analysis patterns
 - **[Troubleshooting](docs/user-guide/troubleshooting.md)** - Solutions to common issues
 

pltr_cli-0.4.0/children.csv

@@ -0,0 +1,3 @@
+description,display_name,name,rid,type
+A child folder,Child Folder,,ri.compass.main.folder.child-folder,folder
+,Child Dataset,Child Dataset,ri.foundry.main.dataset.child-dataset,dataset

{pltr_cli-0.2.0 → pltr_cli-0.4.0}/docs/README.md

@@ -8,6 +8,7 @@ Welcome to the pltr-cli documentation! This CLI tool provides a command-line int
 - **[Quick Start Guide](user-guide/quick-start.md)** - Get up and running in minutes
 - **[Authentication Setup](user-guide/authentication.md)** - Configure token and OAuth2 authentication
 - **[Command Reference](user-guide/commands.md)** - Complete reference for all 50+ commands
+- **[Command Aliases](user-guide/aliases.md)** - Create shortcuts for frequently used commands
 - **[Common Workflows](user-guide/workflows.md)** - Real-world data analysis patterns
 - **[Troubleshooting](user-guide/troubleshooting.md)** - Common issues and solutions
 

pltr_cli-0.4.0/docs/user-guide/aliases.md

@@ -0,0 +1,257 @@
+# Command Aliases
+
+Command aliases allow you to create shortcuts for frequently used commands, improving your productivity when working with pltr-cli.
+
+## Overview
+
+Aliases are custom shortcuts that expand to full commands. They help you:
+- Save time by reducing typing for common operations
+- Create personalized workflows
+- Simplify complex command sequences
+- Build reusable command templates
+
+## Creating Aliases
+
+### Basic Alias
+
+Create a simple alias with the `add` command:
+
+```bash
+# Create an alias 'ds' for 'dataset get'
+pltr alias add ds "dataset get"
+
+# Now you can use:
+pltr ds ri.foundry.main.dataset.123
+# Instead of:
+pltr dataset get ri.foundry.main.dataset.123
+```
+
+### Complex Aliases
+
+Aliases can include options and arguments:
+
+```bash
+# Create an alias for SQL queries with JSON output
+pltr alias add jsonsql "sql execute --format json"
+
+# Usage:
+pltr jsonsql "SELECT * FROM table LIMIT 10"
+```
+
+### Overwriting Existing Aliases
+
+Use the `--force` flag to overwrite an existing alias:
+
+```bash
+pltr alias add ds "dataset list" --force
+```
+
+## Managing Aliases
+
+### List All Aliases
+
+View all configured aliases:
+
+```bash
+pltr alias list
+```
+
+Output:
+```
+┏━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
+┃ Alias   ┃ Command                     ┃
+┡━━━━━━━━━┩━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
+│ ds      │ dataset get                 │
+│ jsonsql │ sql execute --format json   │
+│ onto    │ ontology object-list        │
+└─────────┴─────────────────────────────┘
+```
+
+### Show Specific Alias
+
+Display details of a single alias:
+
+```bash
+pltr alias show ds
+# Output: ds → dataset get
+```
+
+### Edit an Alias
+
+Modify an existing alias:
+
+```bash
+pltr alias edit ds "dataset create"
+```
+
+### Remove an Alias
+
+Delete an alias you no longer need:
+
+```bash
+pltr alias remove ds
+# Or skip confirmation:
+pltr alias remove ds --no-confirm
+```
+
+### Clear All Aliases
+
+Remove all aliases at once:
+
+```bash
+pltr alias clear
+# Or skip confirmation:
+pltr alias clear --no-confirm
+```
+
+## Advanced Features
+
+### Resolve Aliases
+
+See what command an alias expands to:
+
+```bash
+pltr alias resolve ds
+# Output: ds → dataset get
+```
+
+### Export and Import
+
+Export aliases to share with teammates or backup:
+
+```bash
+# Export to file
+pltr alias export --output my-aliases.json
+
+# Export to stdout
+pltr alias export
+```
+
+Import aliases from a file:
+
+```bash
+# Replace existing aliases
+pltr alias import aliases.json
+
+# Merge with existing aliases
+pltr alias import aliases.json --merge
+```
+
+### Nested Aliases
+
+Aliases can reference other aliases:
+
+```bash
+pltr alias add d "dataset"
+pltr alias add dg "d get"
+# 'dg' expands to 'dataset get'
+```
+
+## Common Alias Examples
+
+Here are some useful aliases to get you started:
+
+```bash
+# Dataset operations
+pltr alias add dsg "dataset get"
+pltr alias add dsc "dataset create"
+
+# SQL shortcuts
+pltr alias add sq "sql execute"
+pltr alias add sqj "sql execute --format json"
+pltr alias add sqc "sql execute --format csv"
+pltr alias add sqx "sql export"
+
+# Ontology shortcuts
+pltr alias add ol "ontology list"
+pltr alias add oo "ontology object-list"
+pltr alias add oget "ontology object-get"
+
+# Admin shortcuts
+pltr alias add ul "admin user list"
+pltr alias add uc "admin user current"
+pltr alias add gl "admin group list"
+
+# Combined operations
+pltr alias add quicksql "sql execute --format table --limit 100"
+pltr alias add mydata "dataset get ri.foundry.main.dataset.my-favorite-dataset"
+```
+
+## Shell Integration
+
+Aliases work seamlessly with shell completion and interactive mode:
+
+### Tab Completion
+
+After installing shell completions, alias names are available for tab completion:
+
+```bash
+pltr d<TAB>
+# Shows: ds, dsc, dsg
+```
+
+### Interactive Shell
+
+Aliases are available in the interactive shell:
+
+```bash
+pltr shell
+pltr> ds ri.foundry.main.dataset.123
+# Expands to: dataset get ri.foundry.main.dataset.123
+```
+
+## Best Practices
+
+1. **Use meaningful names**: Choose alias names that are easy to remember
+2. **Keep it simple**: Avoid overly complex aliases that are hard to understand
+3. **Document your aliases**: Export and share team-standard aliases
+4. **Avoid conflicts**: Don't use names that conflict with existing commands
+5. **Test before sharing**: Verify aliases work correctly before distribution
+
+## Limitations
+
+- Aliases cannot use reserved command names (configure, verify, dataset, etc.)
+- Circular references are not allowed and will be detected
+- Aliases are expanded only once (no recursive expansion)
+- Maximum alias chain depth is 10 to prevent infinite loops
+
+## Configuration Storage
+
+Aliases are stored in `~/.config/pltr/aliases.json` and persist across sessions. The file uses standard JSON format and can be manually edited if needed.
+
+## Troubleshooting
+
+### Alias Not Working
+
+1. Check if the alias exists:
+   ```bash
+   pltr alias show myalias
+   ```
+
+2. Verify the alias syntax:
+   ```bash
+   pltr alias resolve myalias
+   ```
+
+3. Test the expanded command directly:
+   ```bash
+   pltr <expanded command>
+   ```
+
+### Circular Reference Error
+
+If you see a circular reference error, check your alias chain:
+
+```bash
+# Example of circular reference (not allowed):
+pltr alias add a "b"
+pltr alias add b "a"  # Error: would create circular reference
+```
+
+### Import Errors
+
+When importing fails, check:
+- File exists and is readable
+- JSON format is valid
+- No circular references in imported aliases
+- No conflicts with reserved command names

{pltr_cli-0.2.0 → pltr_cli-0.4.0}/docs/user-guide/commands.md

@@ -1,6 +1,6 @@
 # Command Reference
 
-Complete reference for all pltr-cli commands. The CLI provides 65+ commands across 8 major command groups for comprehensive Foundry API access.
+Complete reference for all pltr-cli commands. The CLI provides 70+ commands across 9 major command groups for comprehensive Foundry API access.
 
 ## Global Options
 
@@ -147,6 +147,101 @@ pltr dataset create "Analysis Results" --parent-folder ri.foundry.main.folder.xy
 
 ---
 
+## 📁 Folder Commands
+
+Folder operations for managing the Foundry filesystem structure using the foundry-platform-sdk.
+
+### `pltr folder create [OPTIONS] NAME`
+Create a new folder in Foundry.
+
+**Arguments:**
+- `NAME` (required): Folder display name
+
+**Options:**
+- `--parent-folder`, `-p` TEXT: Parent folder RID [default: ri.compass.main.folder.0 (root)]
+- `--profile` TEXT: Profile name
+- `--format`, `-f` TEXT: Output format (table, json, csv) [default: table]
+
+**Examples:**
+```bash
+# Create folder in root
+pltr folder create "My Project"
+
+# Create folder in specific parent
+pltr folder create "Sub Folder" --parent-folder ri.compass.main.folder.xyz123
+
+# Create with JSON output
+pltr folder create "Analysis" --format json
+```
+
+### `pltr folder get [OPTIONS] FOLDER_RID`
+Get detailed information about a specific folder.
+
+**Arguments:**
+- `FOLDER_RID` (required): Folder Resource Identifier
+
+**Options:**
+- `--profile` TEXT: Profile name
+- `--format`, `-f` TEXT: Output format (table, json, csv) [default: table]
+- `--output`, `-o` TEXT: Output file path
+
+**Examples:**
+```bash
+# Get folder info
+pltr folder get ri.compass.main.folder.abc123
+
+# Export as JSON
+pltr folder get ri.compass.main.folder.abc123 --format json --output folder-info.json
+```
+
+### `pltr folder list [OPTIONS] FOLDER_RID`
+List all child resources of a folder.
+
+**Arguments:**
+- `FOLDER_RID` (required): Folder Resource Identifier (use 'ri.compass.main.folder.0' for root)
+
+**Options:**
+- `--profile` TEXT: Profile name
+- `--format`, `-f` TEXT: Output format (table, json, csv) [default: table]
+- `--output`, `-o` TEXT: Output file path
+- `--page-size` INTEGER: Number of items per page
+
+**Examples:**
+```bash
+# List root folder contents
+pltr folder list ri.compass.main.folder.0
+
+# List with pagination
+pltr folder list ri.compass.main.folder.abc123 --page-size 50
+
+# Export children list
+pltr folder list ri.compass.main.folder.abc123 --format csv --output children.csv
+```
+
+### `pltr folder batch-get [OPTIONS] FOLDER_RIDS...`
+Get multiple folders in a single request (max 1000).
+
+**Arguments:**
+- `FOLDER_RIDS...` (required): Space-separated list of folder Resource Identifiers
+
+**Options:**
+- `--profile` TEXT: Profile name
+- `--format`, `-f` TEXT: Output format (table, json, csv) [default: table]
+- `--output`, `-o` TEXT: Output file path
+
+**Examples:**
+```bash
+# Get multiple folders
+pltr folder batch-get ri.compass.main.folder.abc123 ri.compass.main.folder.def456
+
+# Export batch results
+pltr folder batch-get ri.compass.main.folder.abc123 ri.compass.main.folder.def456 --format json --output folders.json
+```
+
+**Root Folder RID**: `ri.compass.main.folder.0` - Use this as the parent folder RID to create folders in the root directory.
+
+---
+
 ## 🎯 Ontology Commands
 
 Comprehensive ontology operations for interacting with Foundry ontologies.
@@ -584,6 +679,11 @@ pltr sql execute "SELECT * FROM table"     # Run SQL query
 pltr ontology list                         # List ontologies
 pltr dataset get <rid>                     # Get dataset info
 
+# Folder Management
+pltr folder create "My Folder"             # Create folder
+pltr folder list ri.compass.main.folder.0  # List root contents
+pltr folder get <folder-rid>               # Get folder info
+
 # Admin
 pltr admin user current                    # Current user info
 pltr admin user list                       # List users

{pltr_cli-0.2.0 → pltr_cli-0.4.0}/docs/user-guide/quick-start.md

@@ -39,7 +39,7 @@ pltr-cli needs to authenticate with your Foundry instance. You have two options:
 If you have a Foundry API token:
 
 ```bash
-pltr configure
+pltr configure configure
 ```
 
 Follow the prompts to enter:

pltr_cli-0.4.0/folder_info.json

@@ -0,0 +1,9 @@
+{
+  "rid": "ri.compass.main.folder.test-folder",
+  "display_name": "Test Folder",
+  "description": "Test folder description",
+  "parent_folder_rid": "ri.compass.main.folder.parent",
+  "created": "2024-01-01T00:00:00Z",
+  "modified": "2024-01-02T00:00:00Z",
+  "type": "folder"
+}

pltr_cli-0.4.0/folders.json

@@ -0,0 +1,11 @@
+[
+  {
+    "rid": "ri.compass.main.folder.test-folder",
+    "display_name": "Test Folder",
+    "description": "Test folder description",
+    "parent_folder_rid": "ri.compass.main.folder.parent",
+    "created": "2024-01-01T00:00:00Z",
+    "modified": "2024-01-02T00:00:00Z",
+    "type": "folder"
+  }
+]

{pltr_cli-0.2.0 → pltr_cli-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pltr-cli"
-version = "0.2.0"
+version = "0.4.0"
 description = "Command-line interface for Palantir Foundry APIs"
 authors = [
     { name = "anjor", email = "anjor@umd.edu" }

{pltr_cli-0.2.0 → pltr_cli-0.4.0}/src/pltr/__main__.py

@@ -23,6 +23,9 @@ if "_PLTR_COMPLETE" in os.environ:
 
 # Normal CLI execution
 from pltr.cli import app
+from pltr.utils.alias_resolver import inject_alias_resolution
 
 if __name__ == "__main__":
+    # Resolve aliases before running the app
+    inject_alias_resolution()
     app()

{pltr_cli-0.2.0 → pltr_cli-0.4.0}/src/pltr/cli.py

@@ -10,11 +10,13 @@ from pltr.commands import (
     configure,
     verify,
     dataset,
+    folder,
     ontology,
     sql,
     admin,
     shell,
     completion,
+    alias,
 )
 
 app = typer.Typer(
@@ -27,6 +29,7 @@ app = typer.Typer(
 app.add_typer(configure.app, name="configure", help="Manage authentication profiles")
 app.add_typer(verify.app, name="verify", help="Verify authentication")
 app.add_typer(dataset.app, name="dataset", help="Manage datasets")
+app.add_typer(folder.app, name="folder", help="Manage folders")
 app.add_typer(ontology.app, name="ontology", help="Ontology operations")
 app.add_typer(sql.app, name="sql", help="Execute SQL queries")
 app.add_typer(
@@ -36,6 +39,7 @@ app.add_typer(
 )
 app.add_typer(shell.shell_app, name="shell", help="Interactive shell mode")
 app.add_typer(completion.app, name="completion", help="Manage shell completions")
+app.add_typer(alias.app, name="alias", help="Manage command aliases")
 
 
 def version_callback(value: bool):