ResourceSpace CLI

A command-line tool for interacting with ResourceSpace digital asset management systems.

Quick Start

# Install
pip install resourcespace-cli

# Configure
rs config set url https://your-resourcespace.com/api
rs config set key your-api-key
rs config set user your-username

# Start using
rs search "landscape photos"
rs download 12345
rs upload photo.jpg

Features

• Search & Discovery - Search resources with filters, view details, list collections and types
• Download - Download single resources or batch download by search query
• Upload - Upload files with metadata, supports glob patterns and batch operations
• Configuration - Secure credential storage with .env file support
• Flexible Output - Human-readable tables or JSON for scripting
• Progress Tracking - Visual progress bars for batch operations

Commands

Command	Description	Example
rs search	Search for resources	rs search "photo" --type 1
rs info	Display resource details	rs info 12345
rs download	Download resources	rs download 12345 -o ./
rs upload	Upload files	rs upload *.jpg --type 2
rs collections list	List collections	rs collections list
rs types list	List resource types	rs types list
rs config set	Set configuration	rs config set url https://...
rs config get	View configuration	rs config get
rs config clear	Clear configuration	rs config clear --all

Global Options

• --json - Output results as JSON
• --no-color - Disable colored output
• --version - Show version information
• --help - Show help for any command

Installation

Using pip:

pip install resourcespace-cli

Using pipx (recommended for CLI tools):

pipx install resourcespace-cli

Development installation:

git clone https://github.com/TidalStudio/ResourceSpace-CLI.git
cd ResourceSpace-CLI
pip install -e ".[dev]"

Configuration

The CLI uses environment variables or a .env file for configuration:

Variable	Description
RESOURCESPACE_API_URL	Your ResourceSpace API endpoint
RESOURCESPACE_API_KEY	Your API key
RESOURCESPACE_USER	Your username

Use rs config set commands for easy setup, or create a .env file manually.

Documentation

• Installation Guide
• Configuration Guide
• Command Reference
• Common Workflows
• Troubleshooting
• Development Guide