.do
Cli

Rpc CLI

Command-line interface reference for rpc.do - Remote Procedure Call (RPC) services

Rpc CLI

Remote Procedure Call (RPC) services

Installation

# Install globally
npm install -g do

# Or use via npx
npx do --version

Quick Start

# Basic usage
do protocol rpc connect wss://server.com

Commands

Main Command

do protocol rpc connect wss://server.com

Description: Remote Procedure Call (RPC) services

Usage:

do rpc [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 rpc \
  --option1=value1 \
  --option2=value2 \
  --verbose

Usage Examples

Basic Example

# Simple usage
do protocol rpc connect wss://server.com

With Options

# With configuration
do protocol rpc connect wss://server.com --verbose --json

Interactive Mode

# Interactive prompts
do rpc --interactive

Batch Operations

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

Pipeline Integration

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

Configuration

Config File

Create .doconfig in your project:

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

Environment Variables

export DO_RPC_OPTION1=value1
export DO_RPC_OPTION2=value2

do protocol rpc connect wss://server.com

Output Formats

Default Output

do protocol rpc connect wss://server.com
# ✓ Operation completed
# Result: ...

JSON Output

do protocol rpc connect wss://server.com --json
# {
#   "success": true,
#   "result": { ... }
# }

Verbose Output

do protocol rpc connect wss://server.com --verbose
# → Starting operation...
# → Processing...
# → Completed in 1.2s

Scripting

Bash Scripts

#!/bin/bash

# Check if successful
if do protocol rpc connect wss://server.com; then
  echo "Success!"
else
  echo "Failed!"
  exit 1
fi

CI/CD Integration

# GitHub Actions
- name: Run Rpc
  run: |
    do protocol rpc connect wss://server.com \
      --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 protocol rpc connect wss://server.com 2>errors.log

# Handle errors
if ! do protocol rpc connect wss://server.com; then
  echo "Error occurred, check errors.log"
  exit 1
fi

Debugging

# Debug mode
DEBUG=* do protocol rpc connect wss://server.com

# Dry run
do protocol rpc connect wss://server.com --dry-run

# Verbose + timing
time do protocol rpc connect wss://server.com --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