@output.ai/cli 0.4.0 → 0.4.1

package/README.md

@@ -1,194 +1,59 @@
 # @output.ai/cli
 
-CLI tool for generating Output workflows.
+Command-line interface for creating and running Output Framework workflows.
+
+[![npm version](https://img.shields.io/npm/v/@output.ai/cli)](https://www.npmjs.com/package/@output.ai/cli)
+[![Documentation](https://img.shields.io/badge/docs-docs.output.ai-blue)](https://docs.output.ai/packages/cli)
 
 ## Installation
 
 ```bash
-# Install globally from the CLI package
-cd sdk/cli && npm link
-
-# Or run directly from the monorepo
-npx @output.ai/cli
+npm install -g @output.ai/cli
 ```
 
-## Usage
-
-### Initialize a New Project
+## Quick Start
 
 ```bash
-# Create a new Output SDK project
+# Create a new project
 output init my-project
-```
+cd my-project
 
-#### What It Does
-
-Creates a complete Output SDK project structure with:
-- Example workflows demonstrating SDK features
-- TypeScript project configuration
-- Agent configuration files
-
-### Start Development Services
-
-```bash
-# Start with automatic file watching (default)
+# Start development services
 output dev
 
-# Start without file watching
-output dev --no-watch
-```
-
-#### What It Does
-
-The `dev` command orchestrates your entire development environment:
-1. Starts Docker services (Temporal, Redis, PostgreSQL)
-2. Launches the API server for workflow execution
-3. Starts the worker to process workflows
-4. Opens Temporal UI for workflow monitoring
-5. Automatically restarts the worker when source files change
-6. Provides a unified log view of all services
-
-This is the primary command for local development - it handles all the complexity of running multiple services and keeps them synchronized.
-
-#### Automatic File Watching
-
-By default, the worker container automatically restarts when you modify files in:
-- `src/` - Your workflow source files and implementations
-- `package.json` - When dependencies change
-
-This feature uses Docker Compose's native watch functionality (requires Docker Compose v2.22+).
-
-#### Command Options
-
-- `--no-watch` - Disable automatic container restart on file changes
-
-### List Workflows
-
-```bash
-# List all available workflows (simple list, default)
-output workflow list
-
-# List workflows with custom API URL
-API_URL=http://localhost:3001 output workflow list
-
-# List workflows with authentication
-API_AUTH_TOKEN=your-token output workflow list
-
-# Show detailed table view with all information
-output workflow list --format table
-
-# Show detailed table with expanded parameter info
-output workflow list --format table --detailed
-
-# List workflows in JSON format
-output workflow list --format json
-
-# Filter workflows by name (partial match)
-output workflow list --filter simple
+# Run a workflow
+output workflow run simple --input '{"question": "who is ada lovelace?"}'
 ```
 
-#### Command Options
-
-- `--format, -f` - Output format: `list` (default, simple column), `table`, or `json`
-- `--detailed, -d` - Show detailed parameter information in table view
-- `--filter` - Filter workflows by name (case-insensitive partial match)
-
-The list command connects to the API server and retrieves all available workflows. By default, it displays a simple list of workflow names (like `ls`). Use `--format table` for detailed information.
-
-### Debug a Workflow Execution
-
-```bash
-# Display trace information for a workflow run
-output workflow debug <workflowId>
-
-# Display trace in JSON format
-output workflow debug <workflowId> --format json
-```
-
-#### What It Does
-
-The `debug` command retrieves and displays detailed execution traces for debugging workflow runs. It shows:
-- Complete execution timeline with all events
-- Hierarchical execution tree showing workflow structure
-- Step and activity inputs/outputs
-- Error details and stack traces
-- Performance metrics and durations
-
-#### Command Options
-
-- `--format, -f` - Output format: `text` (default, human-readable) or `json` (raw trace data)
-
-#### Environment Variables
-
-- `HOST_TRACE_PATH` - When running in Docker, this maps the container's trace log path to the host filesystem path. Set this to your project's `logs` directory (e.g., `${PWD}/logs`). Required for trace files to be accessible from the CLI when workflows run in containers.
-
-### Generate a Workflow
-
-```bash
-# Generate a complete workflow with example steps
-output workflow generate my-workflow --description "My awesome workflow"
-
-# Generate a minimal skeleton workflow
-output workflow generate my-workflow --skeleton
-
-# Generate in a specific directory
-output workflow generate my-workflow --output-dir ./src/workflows
-
-# Force overwrite existing workflow
-output workflow generate my-workflow --force
-```
-
-#### Command Options
-
-- `--description, -d` - Description of the workflow
-- `--skeleton, -s` - Generate minimal skeleton without example steps
-- `--output-dir, -o` - Output directory (default: `src/`)
-- `--force, -f` - Overwrite existing directory
-
-#### Generated Structure
-
-The CLI creates a complete workflow structure:
-
-```
-my-workflow/
-├── workflow.ts          # Main workflow definition
-├── steps.ts          # Activity/step implementations
-├── prompt@v1.prompt  # LLM prompt template (if not skeleton)
-└── README.md         # Workflow documentation
-```
-
-### Initialize Agent Configuration
-
-```bash
-# Initialize agent configuration for your coding agent
-output-cli agents init
-
-# Specify your agent provider (default: claude-code)
-output-cli agents init --agent-provider claude-code
-
-# Force overwrite existing configuration
-output-cli agents init --force
-```
-
-#### What It Does
-
-Sets up your coding agent of choice with context files, sub-agents, and slash commands for working with the Output SDK effectively. It creates a `.outputai/` directory and wires up your coding agent to the context files.
-
-**Note:** Currently this only works for [Claude Code](https://claude.ai/code), but we plan to add support for other coding agents over time.
-
-#### Command Options
+## Command Reference
 
-- `--agent-provider` - Specify the coding agent provider (default: `claude-code`)
-- `--force, -f` - Overwrite existing agent configuration files
+| Command | Description |
+|---------|-------------|
+| `output init` | Initialize a new project |
+| `output dev` | Start development services (Temporal, API, Worker) |
+| `output agents init` | Initialize AI agent configurations |
+| `output workflow plan` | Generate a workflow plan from description |
+| `output workflow generate` | Generate a workflow from plan |
+| `output workflow list` | List available workflows |
+| `output workflow run` | Execute a workflow synchronously |
+| `output workflow start` | Start a workflow asynchronously |
+| `output workflow status` | Get workflow execution status |
+| `output workflow result` | Get workflow execution result |
+| `output workflow stop` | Stop a workflow execution |
 
-#### Output Agent Commands
+## Development Services
 
-**`/plan_workflow`** - Guides you through structured workflow planning to create comprehensive implementation blueprints before writing code.
+Running `output dev` starts:
 
-#### Output Sub-Agents
+| Service | URL | Description |
+|---------|-----|-------------|
+| Temporal UI | http://localhost:8080 | Monitor and debug workflows |
+| API Server | http://localhost:3001 | REST API for workflow execution |
+| Worker | — | Processes workflows with auto-reload |
 
-**`workflow_planner`** - A specialized AI agent that helps with workflow architecture and planning, including requirements analysis, schema design, and testing strategy definition.
+## Documentation
 
-## About
+For comprehensive documentation, visit:
 
-Built with [OCLIF](https://oclif.io) - see their documentation for advanced CLI features, plugins, and configuration options.
+- [CLI Reference](https://docs.output.ai/packages/cli)
+- [Getting Started](https://docs.output.ai/quickstart)

package/dist/templates/project/.gitignore.template

@@ -1,8 +1,5 @@
 # Dependencies
 node_modules/
-package-lock.json
-yarn.lock
-bun.lockb
 
 # Build output
 dist/

package/dist/templates/project/README.md.template

@@ -30,7 +30,7 @@ Edit `.env` to add:
 ### 3. Start Output Services
 
 ```bash
-output dev
+npx output dev
 ```
 
 This starts:
@@ -44,7 +44,7 @@ This starts:
 In a new terminal:
 
 ```bash
-output workflow run simple --input '{"question": "who really is ada lovelace?"}'
+npx output workflow run simple --input '{"question": "who really is ada lovelace?"}'
 ```
 
 ### 5. Stop Services

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@output.ai/cli",
-  "version": "0.4.0",
+  "version": "0.4.1",
   "description": "CLI for Output.ai workflow generation",
   "type": "module",
   "main": "dist/index.js",
@@ -43,7 +43,10 @@
     "copyfiles": "2.4.1",
     "orval": "7.13.2"
   },
-  "license": "UNLICENSED",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public"
+  },
   "imports": {
     "#*": "./dist/*"
   },