DevTeam Orchestrator v1.0 is live. Read the changelog →
Getting Started
Installation

Installation

DevTeam Orchestrator provides two packages:

  • devteam-sdk -- TypeScript/JavaScript library for programmatic integration
  • devteam-orchestrator-cli -- Command-line interface for interactive use and scripting

SDK Installation

npm install devteam-sdk

TypeScript Support

The SDK ships with full TypeScript definitions. No additional @types package is needed.

tsconfig.json
{
  "compilerOptions": {
    "moduleResolution": "bundler",
    "target": "ES2020",
    "strict": true
  }
}

Minimum Requirements

RequirementVersion
Node.js>= 18.0.0
TypeScript>= 5.0 (optional)
npm>= 9.0

CLI Installation

Install the CLI globally:

npm install -g devteam-orchestrator-cli

Verify the installation:

devteam --version
# devteam-orchestrator-cli v1.0.0
 
devteam --help
# Usage: devteam <command> [options]
#
# Commands:
#   login          Authenticate with DevTeam API
#   run            Execute a single task
#   plan           Create and run DAG workflows
#   templates      Manage workflow templates
#   status         Check task/plan status
#   logs           View task execution logs
#   config         Manage CLI configuration

Shell Completions

Enable tab completions for your shell:

# Bash
devteam completions bash >> ~/.bashrc
 
# Zsh
devteam completions zsh >> ~/.zshrc
 
# Fish
devteam completions fish > ~/.config/fish/completions/devteam.fish

Docker Installation

For containerized environments, use the official Docker image:

Dockerfile
FROM node:20-slim
 
RUN npm install -g devteam-orchestrator-cli
 
# Your application
WORKDIR /app
COPY package.json .
RUN npm install
COPY . .
 
CMD ["node", "index.js"]

Or run the CLI directly from Docker:

docker run --rm -it \
  -e DEVTEAM_API_KEY=$DEVTEAM_API_KEY \
  matwal/devteam-cli:latest \
  run "Analyze this dataset" --model sonnet

Worker Installation

To run a worker node that processes tasks from the queue:

npm install -g devteam-worker

Configure and start the worker:

/etc/devteam/worker.env
DEVTEAM_API_URL=https://devteam.marsala.dev
DEVTEAM_WORKER_QUEUE=gpu-queue
DEVTEAM_WORKER_CONCURRENCY=4
TEMPORAL_ADDRESS=temporal.marsala.dev:7233
TEMPORAL_NAMESPACE=default
devteam-worker start
# Worker registered: worker_asus_gpu_01
# Listening on queue: gpu-queue (concurrency: 4)
# Connected to Temporal at temporal.marsala.dev:7233
⚠️

Workers require network access to both the API server and the Temporal server. Ensure your firewall rules allow outbound connections on ports 443 (API) and 7233 (Temporal).

Verifying Your Installation

Run the built-in health check:

devteam doctor

Expected output:

DevTeam Doctor v1.0.0
=====================
Node.js version     18.20.0     OK
npm version         10.5.0      OK
CLI version         1.0.0       OK
SDK version         1.0.0       OK
API connection      connected   OK
Auth status         logged in   OK
Temporal            reachable   OK

All checks passed.

Next Steps

Quick StartConfiguration