Package Exports
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@relayplane/cli) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
@relayplane/cli
🪄 Zero-config AI for developers - Experience RelayPlane's magic in 30 seconds
The RelayPlane CLI provides an instant playground, demo tool, and powerful one-liner commands that transform complex AI workflows into simple terminal commands. No setup required - just run and experience the magic!
✨ Zero-Config Wins
Experience the core zero-config win - just ask AI anything with zero configuration:
- 🪄 Zero-Config Quick Start - Just ask anything, no configuration needed
- 🎯 Smart Model Selection - See intelligent reasoning for model choices
- 📚 Built-in Examples - Ready-to-use patterns for common tasks
- ⚡ Performance Comparison - Test different optimization strategies
- 🔧 Contextual Error Recovery - Helpful suggestions when things go wrong
- 🎨 Custom Demos - Try your own prompts with various options
🚀 Quick Start
Instant Demo (No Installation)
# Experience the magic immediately
npx @relayplane/cli demoTest Your Setup
# Quick connectivity test
npx @relayplane/cli testInitialize New Project
# Set up RelayPlane in your project
npx @relayplane/cli init⚡ Power User One-Liners
Transform complex AI workflows into simple terminal commands. Perfect for power users who want maximum productivity with minimal friction.
🔄 Data Transformation Pipeline
Transform data files through multiple AI operations in sequence:
# Clean, analyze, and summarize a CSV file
rp transform -i data.csv -o "clean,analyze,summarize" --format markdown
# Translate and structure a document
rp transform -i document.txt -o "translate,structure" --output report.md
# Process with custom format
rp transform -i raw-data.json -o "clean,analyze" --format jsonAvailable Operations:
clean- Remove inconsistencies and normalize dataanalyze- Extract insights and patternssummarize- Create concise summariestranslate- Translate or improve language qualitystructure- Reorganize into logical format
🔍 Multi-Agent Code Review
Get specialized AI agents to review your code from different perspectives:
# Security and performance review
rp review -f src/app.js -a "security,performance" --format markdown
# Comprehensive review with all agents
rp review -f components/Button.tsx -a "security,performance,style,logic,architecture"
# Critical issues only, save to file
rp review -f api/auth.py -a "security,logic" --severity critical -o review-report.mdAvailable Agents:
security- Vulnerabilities and security anti-patternsperformance- Bottlenecks and optimization opportunitiesstyle- Code standards and maintainabilitylogic- Bugs and correctness issuesarchitecture- Design patterns and structure
📦 Batch Content Processing
Process multiple files with AI operations using pattern matching:
# Translate all markdown files to Spanish
rp batch -p "*.md" -o translate -t Spanish --concurrent 3
# Summarize all documentation files
rp batch -p "docs/**/*.md" -o summarize --output summaries/
# Optimize all content files (dry run first)
rp batch -p "content/*.txt" -o optimize --dry-runAvailable Operations:
translate- Translate to target languagesummarize- Create concise summariesoptimize- Improve readability and engagementformat- Restructure with proper organization
📚 Smart Documentation Generation
Generate comprehensive documentation with AI analysis:
# API reference documentation
rp docs -s src/ --style api-reference --include-examples -o docs/
# Tutorial-style documentation
rp docs -s components/ --style tutorial --include-examples
# Technical documentation for developers
rp docs -s lib/ --style technical --format markdown -o technical-docs/Available Styles:
api-reference- Function signatures, parameters, examplestutorial- Step-by-step learning guideoverview- High-level system explanationtechnical- Detailed implementation docsuser-guide- Practical usage scenarios
🚀 AI-Powered Deployment Pipeline
Run comprehensive deployment checks with automated fixes:
# Staging deployment with auto-fix
rp deploy -e staging -c "security,performance,compatibility" --auto-fix
# Production readiness check (dry run)
rp deploy -e production -c "security,performance,testing" --dry-run
# Custom configuration file
rp deploy -e staging -c "security,compatibility" --config deploy.yamlAvailable Checks:
security- Security vulnerabilities and configurationsperformance- Performance bottlenecks and scalabilitycompatibility- Dependencies and environment requirementstesting- Test coverage and critical path verification
🎯 Demo Experiences
🪄 Zero-Config Magic
Experience the core zero-config win - just ask AI anything with zero configuration:
npx @relayplane/cli demo
# Select: "🪄 Zero-Config Magic - Just ask anything!"What you'll see:
- One-line AI access with no setup
- Automatic model selection based on your available API keys
- Intelligent reasoning for why a specific model was chosen
- Beautiful terminal output with real-time feedback
🎯 Smart Model Selection
See how RelayPlane intelligently chooses models based on task type and budget:
npx @relayplane/cli demo
# Select: "🎯 Smart Model Selection - See the reasoning"What you'll see:
- Different tasks (coding, creative, analysis) getting optimal models
- Budget-aware model selection (minimal, moderate, unlimited)
- Real-time reasoning display for each model choice
- Performance and cost comparisons
📚 Built-in Examples Library
Test ready-to-use patterns for common AI tasks:
npx @relayplane/cli demo
# Select: "📚 Built-in Examples - Ready-to-use patterns"What you'll see:
- Summarization with configurable length
- Translation between languages
- Code review with focus areas
- Real examples running with your API keys
⚡ Performance Comparison
Compare different optimization strategies side by side:
npx @relayplane/cli demo
# Select: "⚡ Performance Comparison - Multiple models"What you'll see:
- Same prompt tested with different strategies (fastest, balanced, cheapest)
- Execution time and cost comparisons
- Model selection reasoning for each strategy
- Performance vs. cost trade-off analysis
🔧 Smart Error Recovery
See helpful error messages and recovery suggestions:
npx @relayplane/cli demo
# Select: "🔧 Error Recovery - See helpful suggestions"What you'll see:
- Contextual error messages with specific solutions
- Copy-paste commands to fix common issues
- Environment detection and configuration guidance
- Troubleshooting workflow recommendations
🎨 Custom Demo Experience
Try your own prompts with various optimization options:
npx @relayplane/cli demo
# Select: "🎨 Custom Demo - Your own prompt"What you'll see:
- Interactive prompt input
- Configurable optimization options (speed, cost, reasoning)
- Real-time model selection and execution
- Detailed reasoning display for your specific use case
💡 Power User Examples
Complex Workflow Combinations
# Complete documentation pipeline
rp docs -s src/ --style api-reference --include-examples && \
rp batch -p "docs/*.md" -o optimize && \
rp deploy -e staging -c "compatibility" --dry-run
# Multi-language content processing
rp batch -p "content/en/*.md" -o translate -t Spanish --output content/es/ && \
rp batch -p "content/es/*.md" -o optimize
# Comprehensive code quality pipeline
rp review -f src/critical.js -a "security,performance,logic" --severity critical && \
rp docs -s src/ --style technical && \
rp deploy -e production -c "security,performance,testing" --auto-fixAdvanced Configuration
# High-concurrency batch processing
rp batch -p "data/**/*.csv" -o "clean,analyze" --concurrent 10 --output processed/
# Detailed documentation with examples
rp docs -s packages/ --style api-reference --include-examples --format markdown -o api-docs/
# Comprehensive deployment checks
rp deploy -e production -c "security,performance,compatibility,testing" --config .deploy/prod.yaml --auto-fix📦 Installation
npm install @relayplane/cli⚙️ Configuration (Optional!)
RelayPlane works without configuration, but you can customize it:
# Configure with API key
rp configure --api-key your-relayplane-key
# Force local mode detection
rp configure --local
# Check current configuration
rp features --verbose🔧 Advanced Features
Command Chaining & Automation
All power user commands are designed to work together in scripts and CI/CD pipelines:
#!/bin/bash
# Automated content pipeline
# Step 1: Generate documentation
rp docs -s src/ --style api-reference --include-examples -o docs/
# Step 2: Optimize all content
rp batch -p "docs/**/*.md" -o optimize --concurrent 5
# Step 3: Run deployment checks
rp deploy -e staging -c "security,performance" --auto-fix
echo "Pipeline complete! 🚀"Error Handling & Debugging
# Dry run mode for testing
rp batch -p "*.md" -o translate -t French --dry-run
# Verbose output for debugging
rp features --verbose --json > status.json
# Test connectivity before running operations
rp test && rp transform -i data.csv -o "clean,analyze"Performance Optimization
# Concurrent processing for large datasets
rp batch -p "data/**/*.txt" -o summarize --concurrent 10
# Memory-efficient single operations
rp transform -i large-file.csv -o "clean" --concurrent 1
# Output format optimization
rp review -f src/app.js -a "security" --format json -o report.json🚀 Getting Started
- Try the demo first -
npx @relayplane/cli demo - Test your setup -
npx @relayplane/cli test - Explore power commands - Start with
rp transform --help - Build workflows - Combine commands for complex pipelines
- Automate everything - Add to your CI/CD and daily workflows
🆘 Need Help?
# General help
rp --help
# Command-specific help
rp transform --help
rp review --help
rp batch --help
rp docs --help
rp deploy --help
# Check your configuration
rp features --verbose
# Test connectivity
rp test🌟 Pro Tips
- Start with dry runs - Use
--dry-runto preview operations - Use concurrency - Speed up batch operations with
-cflag - Chain commands - Combine multiple operations for powerful workflows
- Save outputs - Use
-oflags to save results for later use - Check status - Run
rp featuresto see what's available
Ready to experience the magic?
npx @relayplane/cli demo