@output.ai/cli 0.7.12-dev.pr263-5d2eaa9 → 0.7.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -67
- package/dist/generated/sdk_versions.json +4 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -3,73 +3,8 @@
|
|
|
3
3
|
Command-line interface for creating and running Output Framework workflows.
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/@output.ai/cli)
|
|
6
|
-
[](https://docs.output.ai/packages/cli)
|
|
7
|
-
|
|
8
|
-
> **Full Documentation**: For detailed command options, flags, and examples, see the [CLI Reference](https://docs.output.ai/packages/cli).
|
|
9
|
-
|
|
10
|
-
## Quick Start
|
|
11
|
-
|
|
12
|
-
```bash
|
|
13
|
-
# Create a new project
|
|
14
|
-
npx @output.ai/cli init
|
|
15
|
-
cd <project-name>
|
|
16
|
-
|
|
17
|
-
# Start development services
|
|
18
|
-
npx output dev
|
|
19
|
-
|
|
20
|
-
# Run a workflow
|
|
21
|
-
npx output workflow run blog_evaluator --input src/workflows/blog_evaluator/scenarios/paulgraham_hwh.json
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
## Environment Configuration
|
|
25
|
-
|
|
26
|
-
By default, the CLI loads environment variables from `.env` in the current directory.
|
|
27
|
-
|
|
28
|
-
To use a different env file, set the `OUTPUT_CLI_ENV` environment variable:
|
|
29
|
-
|
|
30
|
-
```bash
|
|
31
|
-
# Use production environment
|
|
32
|
-
OUTPUT_CLI_ENV=.env.prod npx output workflow list
|
|
33
|
-
|
|
34
|
-
# Use staging environment
|
|
35
|
-
OUTPUT_CLI_ENV=.env.staging npx output workflow run my-workflow
|
|
36
|
-
|
|
37
|
-
# Absolute path
|
|
38
|
-
OUTPUT_CLI_ENV=/etc/output/production.env npx output workflow status wf-123
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
## Command Reference
|
|
42
|
-
|
|
43
|
-
| Command | Description |
|
|
44
|
-
|---------|-------------|
|
|
45
|
-
| `output init` | Initialize a new project |
|
|
46
|
-
| `output dev` | Start development services (Temporal, API, Worker) |
|
|
47
|
-
| `output agents init` | Initialize AI agent configurations |
|
|
48
|
-
| `output workflow plan` | Generate a workflow plan from description |
|
|
49
|
-
| `output workflow generate` | Generate a workflow from plan |
|
|
50
|
-
| `output workflow list` | List available workflows |
|
|
51
|
-
| `output workflow runs list` | List recent workflow runs |
|
|
52
|
-
| `output workflow run` | Execute a workflow synchronously |
|
|
53
|
-
| `output workflow start` | Start a workflow asynchronously |
|
|
54
|
-
| `output workflow status` | Get workflow execution status |
|
|
55
|
-
| `output workflow result` | Get workflow execution result |
|
|
56
|
-
| `output workflow stop` | Stop a workflow execution |
|
|
57
|
-
| `output workflow terminate` | Terminate a workflow execution (force stop) |
|
|
58
|
-
| `output workflow debug` | Display workflow execution trace |
|
|
59
|
-
|
|
60
|
-
## Development Services
|
|
61
|
-
|
|
62
|
-
Running `output dev` starts:
|
|
63
|
-
|
|
64
|
-
| Service | URL | Description |
|
|
65
|
-
|---------|-----|-------------|
|
|
66
|
-
| Temporal UI | http://localhost:8080 | Monitor and debug workflows |
|
|
67
|
-
| API Server | http://localhost:3001 | REST API for workflow execution |
|
|
68
|
-
| Worker | - | Processes workflows with auto-reload |
|
|
69
6
|
|
|
70
7
|
## Documentation
|
|
8
|
+
- [README](https://docs.output.ai/packages/cli)
|
|
71
9
|
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
- [CLI Reference](https://docs.output.ai/packages/cli) - Complete command documentation
|
|
75
|
-
- [Getting Started](https://docs.output.ai/quickstart) - Project setup guide
|
|
10
|
+
<!-- Internal Dev Note: The documentation for this package is found at docs/guides/packages/cli.mdx -->
|