.do
Cli

Studio CLI

Command-line interface reference for studio.do - Custom-branded Payload Content Management System (CMS) for admin and content

Studio CLI

Custom-branded Payload Content Management System (CMS) for admin and content

Installation

# Install globally
npm install -g do

# Or use via npx
npx do --version

Quick Start

# Basic usage
do cms studio manage posts

Commands

Main Command

do cms studio manage posts

Description: Custom-branded Payload Content Management System (CMS) for admin and content

Usage:

do studio [options]

Options

Global Options

  • --help, -h - Show help
  • --version, -v - Show version
  • --verbose - Verbose output
  • --quiet, -q - Quiet mode
  • --json - JSON output
  • --config <file> - Config file path

Command-Specific Options

do studio \
  --option1=value1 \
  --option2=value2 \
  --verbose

Usage Examples

Basic Example

# Simple usage
do cms studio manage posts

With Options

# With configuration
do cms studio manage posts --verbose --json

Interactive Mode

# Interactive prompts
do studio --interactive

Batch Operations

# Process multiple items
do studio --batch items.json

Pipeline Integration

# Use with pipes
cat data.json | do studio --stdin | jq '.'

Configuration

Config File

Create .doconfig in your project:

{
  "studio": {
    "option1": "value1",
    "option2": "value2"
  }
}

Environment Variables

export DO_STUDIO_OPTION1=value1
export DO_STUDIO_OPTION2=value2

do cms studio manage posts

Output Formats

Default Output

do cms studio manage posts
# ✓ Operation completed
# Result: ...

JSON Output

do cms studio manage posts --json
# {
#   "success": true,
#   "result": { ... }
# }

Verbose Output

do cms studio manage posts --verbose
# → Starting operation...
# → Processing...
# → Completed in 1.2s

Scripting

Bash Scripts

#!/bin/bash

# Check if successful
if do cms studio manage posts; then
  echo "Success!"
else
  echo "Failed!"
  exit 1
fi

CI/CD Integration

# GitHub Actions
- name: Run Studio
  run: |
    do cms studio manage posts \
      --config prod.json \
      --quiet

Error Handling

Exit Codes

  • 0 - Success
  • 1 - General error
  • 2 - Invalid arguments
  • 3 - Timeout
  • 4 - Not found

Error Messages

# Capture errors
do cms studio manage posts 2>errors.log

# Handle errors
if ! do cms studio manage posts; then
  echo "Error occurred, check errors.log"
  exit 1
fi

Debugging

# Debug mode
DEBUG=* do cms studio manage posts

# Dry run
do cms studio manage posts --dry-run

# Verbose + timing
time do cms studio manage posts --verbose

Best Practices

  1. Use Config Files - Store configuration in .doconfig
  2. Environment Variables - Use for sensitive data
  3. Error Handling - Check exit codes in scripts
  4. JSON Output - Use --json for parsing results
  5. Verbose Mode - Use --verbose for debugging