Skip to main content

​
Prerequisites

  • Node.js 20+
  • Docker and Docker Compose v2.22+

​
Install the CLI

npm install -g @output.ai/cli

​
Create a Project

Initialize a new Output Framework project: 
output init my-project
cd my-project
This creates a project with:
  • src/workflows/ — Your workflow implementations
  • .outputai/ — Agent configurations for AI-assisted development
  • .claude/ — Claude Code integration
  • package.json — Project dependencies and scripts

​
Start Development

Launch the development environment: 
output dev
This starts the following services:
ServiceURLDescription
Temporal UIhttp://localhost:8080Monitor and debug workflows
API Serverhttp://localhost:3001REST API for workflow execution
Worker—Processes workflows with auto-reload
PostgreSQLlocalhost:5432Temporal persistence
Redislocalhost:6379Caching layer
Open the Temporal UI at http://localhost:8080 to monitor workflow executions, view history, and debug issues.

​
Run Your First Workflow

With the dev environment running, execute a workflow: 
output workflow run simple --input '{"question": "who is ada lovelace?"}'
Monitor the execution in the Temporal UI at http://localhost:8080.

​
Generate a New Workflow

Create workflows using AI-assisted generation or manually.
Step 1: Plan the workflow
output workflow plan --description "A workflow that summarizes articles"
This generates a plan file in .outputai/plans/. Review and modify the plan interactively, then type ACCEPT when satisfied.Step 2: Generate from the plan
output workflow generate summarize --plan-file .outputai/plans/2025_01_15_summarize/PLAN.md
The CLI uses AI to implement the workflow based on your plan, with an interactive refinement loop.

​
Project Structure

my-project/
├── src/
│   └── workflows/
│       └── simple/
│           ├── workflow.js  # Workflow definition
│           ├── steps.js     # Step implementations
│           └── prompts/     # LLM prompt templates
├── .outputai/               # Agent configurations
│   ├── agents/              # Agent definitions
│   ├── commands/            # Slash commands
│   └── plans/               # Generated workflow plans
├── .claude/                 # Claude Code integration
└── package.json

​
Next Steps

Workflows

Learn how to define and orchestrate workflows.

Steps

Understand steps and how to handle I/O operations.

CLI Reference

Explore all CLI commands and options.

LLM Package

Integrate LLM generation into your workflows.