📚 MicroRapid CLI Commands Reference

📋 Complete Command Reference

Core Commands

Collection Commands

Authentication Commands

Environment Commands

There is no env use. Select an environment per command with the global --env <name> flag (e.g. tiefrun run GetUser --env staging).

🎯 Command Options Reference

init Command Options

tiefrun init <project-name> [options]

list Command Options

tiefrun list [options]

run Command Options

tiefrun run <operation> [options]

validate Command Options

tiefrun validate <spec-file> [options]

doctor Command Options

tiefrun doctor [options]

Check areas:

• config - Configuration files
• auth - Authentication setup
• spec - OpenAPI specification
• env - Environment variables

diff Command Options — Coming Soon

diff is not yet implemented and will be available in a future release.

tiefrun diff <old-spec> <new-spec> [options]

gen Command Options

tiefrun gen <type> [options]

Generation Types:

Common Options:

collection Command Options

tiefrun collection <subcommand> [options]

collection run Options:

collection test Options:

📖 Complete Examples

Basic API Execution

# Simple GET request
tiefrun run GetUser --param id=123

# With environment and authentication
tiefrun run GetUser \
  --param id=123 \
  --env production \
  --profile api-key-prod

# POST with file and save to collection
tiefrun run CreateUser \
  --file user-data.json \
  --env staging \
  --profile oauth-staging \
  --save-to-collection

Working with GitHub API

# Initialize GitHub API project
tiefrun init github-api \
  --from-url https://raw.githubusercontent.com/github/rest-api-description/main/descriptions/api.github.com/api.github.com.json

# List repository operations
tiefrun list --filter repo --method POST

# Get repository details
tiefrun run repos/get \
  --param owner=microsoft \
  --param repo=vscode \
  --env production \
  --profile github-main

# Create repository with interactive mode
tiefrun run repos/create-for-user -i
# Edit the generated template, then:
tiefrun run repos/create-for-user \
  --file create_repo_request.json \
  --env production \
  --profile github-main \
  --save-to-collection

Authentication Setup

# Detect required authentication
tiefrun auth detect --spec api.yaml

# Configure API key authentication
tiefrun auth connect api-key

# Login to GitHub OAuth
tiefrun auth login github

# Test authentication profile
tiefrun auth test --profile github-main

# Validate production credentials
tiefrun auth validate --profile production

Environment Management

# List all environments
tiefrun env list

# Create QA environment
tiefrun env create qa --base-url https://qa-api.example.com

# Select an environment per command with --env (there is no `env use`)
tiefrun run GetUser --env staging

# Show environment details
tiefrun env show production

Collection Management

# Create a collection by saving a request to it (there is no `collection create`)
tiefrun run GetUser --save-to-collection --collection smoke-tests

# Validate collection syntax
tiefrun collection validate smoke-tests

# Run collection with variables
tiefrun collection run user-onboarding \
  --env staging \
  --var email="test@example.com" \
  --var username="testuser"

# Run as tests with report
tiefrun collection test regression-suite \
  --env staging \
  --report junit > test-results.xml

API Validation and Testing

# Validate OpenAPI spec
tiefrun validate api-spec.yaml --strict --lint

# Run all tests
tiefrun test api.yaml --all --env staging

# Diagnose issues
tiefrun doctor --env production --fix

Code Generation

# Generate TypeScript SDK
tiefrun gen sdk \
  --language typescript \
  --output ./sdk/typescript \
  --package-name "@company/api-client" \
  --with-docs \
  --with-tests

# Generate test fixtures
tiefrun gen fixtures \
  --count 100 \
  --seed 42 \
  --output ./test-data

# Generate curl examples
tiefrun gen snippets \
  --format curl \
  --output ./docs/examples

Advanced Query Building

# Interactive query builder
tiefrun run searchProducts --build-query

# Complex query with filters
tiefrun run searchProducts \
  --param q="category:electronics price:>100" \
  --param sort="price:asc" \
  --param page=1 \
  --param limit=20 \
  --env production \
  --profile api-key

# Use query file
cat > query.json << EOF
{
  "filter": "status = 'active' and created >= '2024-01-01'",
  "sort": "created:desc",
  "page": 1,
  "limit": 50
}
EOF

tiefrun run listItems --query-file query.json

Debugging and Development

# Preview request without sending
tiefrun run DeleteUser \
  --param id=123 \
  --dry-run

# Show as curl command
tiefrun run DeleteUser \
  --param id=123 \
  --as-curl

# Trace HTTP traffic
tiefrun run GetUser \
  --param id=123 \
  --trace \
  --verbose

# Replay last successful request
tiefrun run GetUser --replay-last

🎓 Pro Tips

1. Use Environment-Specific Configs

# Development with verbose output
tiefrun run GetUser --env dev --verbose

# Production with specific profile
tiefrun run GetUser --env prod --profile prod-readonly

2. Chain Operations with Collections

# .tiefrun/collections/user_flow.yaml
requests:
  - name: Create User
    operation: CreateUser
    save_as: user
  
  - name: Add Payment Method
    operation: AddPaymentMethod
    params:
      user_id: "{{ user.id }}"
    depends_on: ["Create User"]

3. Interactive Mode for Complex Requests

# Generate minimal template
tiefrun run ComplexOperation -i --minimal

# Generate full template with all fields
tiefrun run ComplexOperation -i --full

4. Always Validate Before Production

# Dry run first
tiefrun run DeleteUser --param id=123 --dry-run

# Check as curl
tiefrun run DeleteUser --param id=123 --as-curl

5. Set Up Proper Authentication Profiles

# Create profile for each environment
cat > .tiefrun/auth/prod.toml << EOF
[profile]
name = "production"
type = "bearer"

[auth]
token_env = "PROD_API_TOKEN"
EOF

# Use environment-specific profiles
tiefrun run GetUser --env production --profile prod

🔗 Supported Formats

tiefrun init your-api --from-url https://your-api.com/openapi.json