Getting Started

npx cli.do $.Business.create({ name: 'Acme' })

npm install -g cli.do
# or
pnpm add -g cli.do

do $.Business.create({ name: 'Acme' })

npm install cli.do
# or
pnpm add cli.do

npx do $.Business.create({ name: 'Acme' })

# Interactive OAuth login (recommended)
do auth login

# Or set API key
export DO_TOKEN=sk_live_xxxxx

# Or use admin token
export DO_ADMIN_TOKEN=admin_xxxxx

do auth status

# Create a business
do $.Business.create({
  name: 'Acme Corp',
  industry: 'Technology',
  employees: 50
})

# Create a person
do $.Person.create({
  name: 'John Doe',
  email: '[email protected]',
  jobTitle: 'CEO'
})

# List all businesses
do db.list($.Business)

# Get specific business
do db.get($.Business, 'acme-corp')

# Filter results
do db.list($.Business, { where: { industry: 'Technology' } })

# Generate text
do ai.generate('Write a product description for a CRM platform')

# Generate with specific model
do ai.generate({
  prompt: 'Explain quantum computing',
  model: 'claude-sonnet-4.5'
})

# Create embeddings
do ai.embeddings.create('semantic search query')

# Stripe
do api.stripe.customers.create({
  email: '[email protected]',
  name: 'Jane Doe'
})

# SendGrid
do api.sendgrid.sendEmail({
  to: '[email protected]',
  subject: 'Welcome!',
  template: 'welcome-email',
  data: { name: 'Jane' }
})

# Slack
do api.slack.postMessage({
  channel: '#general',
  text: 'Hello from CLI.do!'
})

# Generate lean canvas for all tasks in an occupation
do db.Occupations
  .get('15-1252.00')
  .tasks
  .forEach(task => task.generateLeanCanvas())

# Analyze high-growth industries
do db.Industries
  .filter({ growth: '>10%' })
  .map(industry => industry.analyze())

# Process all pending orders over $1000
do db.Orders
  .filter({ status: 'pending', total: '>1000' })
  .forEach(order => {
    order.$.Manager.approve()
    order.Email.send({ template: 'approval-notification' })
    order.Slack.notify({ channel: '#finance' })
  })

# .env
DO_TOKEN=sk_live_xxxxx           # API key (recommended)
DO_ADMIN_TOKEN=admin_xxxxx       # Admin token (highest priority)
DO_BASE_URL=https://rpc.do       # RPC endpoint

# Set configuration
do config set DO_BASE_URL https://rpc.do

# Get configuration
do config get DO_BASE_URL

# List all configuration
do config list

$ do db.get($.Business, 'acme-corp')
{ id: 'acme-corp', name: 'Acme Corp', industry: 'Technology' }

$ do db.list($.Business) --json
[{"id":"acme-corp","name":"Acme Corp"}]

$ do db.list($.Business) --json --pretty
[
  {
    "id": "acme-corp",
    "name": "Acme Corp"
  }
]

#!/bin/bash

# Fetch users and process them
USERS=$(do db.list($.User) --json)

# Parse with jq
echo "$USERS" | jq '.[] | .email'

# Execute for each user
for user in $(echo "$USERS" | jq -r '.[] | @base64'); do
  _jq() {
    echo ${user} | base64 --decode | jq -r ${1}
  }

  EMAIL=$(_jq '.email')
  do api.sendgrid.sendEmail({ to: "$EMAIL", template: "welcome" })
done

name: Deploy
on: push

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - name: Install CLI
        run: npm install -g cli.do

      - name: Deploy
        env:
          DO_TOKEN: ${{ secrets.DO_TOKEN }}
        run: |
          do wf.run('deployToProduction', { version: "${{ github.sha }}" })

# Check installation
which do

# Reinstall globally
npm install -g cli.do --force

# Or use npx
npx cli.do [code]

Error: Authentication required

export DO_TOKEN=sk_live_xxxxx
# or
do auth login

# Check API health
do health

# Verify configuration
do config list

# Test with curl
curl https://rpc.do/health

# Make sure to use proper JavaScript/TypeScript syntax
do db.list($.Business)  # Correct

# Quotes matter
do $.Business.create({ name: "Acme" })  # Use single quotes in bash