@pixelml/agenticflow-cli 1.1.0 → 1.1.1
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 +85 -167
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,232 +1,150 @@
|
|
|
1
1
|
# @pixelml/agenticflow-cli
|
|
2
2
|
|
|
3
|
-
Command-line interface for the [AgenticFlow](https://agenticflow.ai) platform.
|
|
4
|
-
Manage agents, workflows, connections and more — directly from your terminal.
|
|
3
|
+
Command-line interface for the [AgenticFlow](https://agenticflow.ai) platform — build agents, deploy them to external platforms, and receive tasks from any webhook source.
|
|
5
4
|
|
|
6
5
|
Built on [`@pixelml/agenticflow-sdk`](https://www.npmjs.com/package/@pixelml/agenticflow-sdk).
|
|
7
6
|
|
|
8
|
-
##
|
|
7
|
+
## Install
|
|
9
8
|
|
|
10
9
|
```bash
|
|
11
10
|
npm install -g @pixelml/agenticflow-cli
|
|
12
11
|
```
|
|
13
12
|
|
|
14
|
-
|
|
13
|
+
Available as both `agenticflow` and `af` (short alias). Requires Node.js 18+.
|
|
15
14
|
|
|
16
|
-
|
|
17
|
-
npx @pixelml/agenticflow-cli --help
|
|
18
|
-
```
|
|
19
|
-
|
|
20
|
-
## Authentication
|
|
21
|
-
|
|
22
|
-
### Interactive login
|
|
15
|
+
## Quick Start
|
|
23
16
|
|
|
24
17
|
```bash
|
|
25
|
-
|
|
18
|
+
af login # Authenticate
|
|
19
|
+
af doctor --json # Verify setup
|
|
20
|
+
af agent list --fields id,name,model --json # List agents
|
|
21
|
+
af agent stream --agent-id <id> --body '{"messages":[{"content":"Hello!"}]}'
|
|
26
22
|
```
|
|
27
23
|
|
|
28
|
-
|
|
29
|
-
`~/.agenticflow/auth.json`.
|
|
24
|
+
> **AI agents**: Run `af context --json` for a machine-readable bootstrap guide.
|
|
30
25
|
|
|
31
|
-
|
|
26
|
+
## Authentication
|
|
32
27
|
|
|
33
28
|
```bash
|
|
34
|
-
|
|
35
|
-
export
|
|
36
|
-
|
|
29
|
+
af login # Interactive (saves to ~/.agenticflow/auth.json)
|
|
30
|
+
export AGENTICFLOW_API_KEY=<key> # Environment variable
|
|
31
|
+
af --api-key <key> agent list # CLI flag
|
|
32
|
+
af auth import-env --file .env # Import from .env
|
|
33
|
+
af whoami --json # Verify
|
|
37
34
|
```
|
|
38
35
|
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
```bash
|
|
42
|
-
agenticflow auth import-env --file .env
|
|
43
|
-
```
|
|
36
|
+
## Core Commands
|
|
44
37
|
|
|
45
|
-
###
|
|
38
|
+
### Agents
|
|
46
39
|
|
|
47
40
|
```bash
|
|
48
|
-
|
|
41
|
+
af agent list --fields id,name,model --json
|
|
42
|
+
af agent get --agent-id <id> --json
|
|
43
|
+
af agent create --body @agent.json --dry-run # Validate first
|
|
44
|
+
af agent create --body @agent.json
|
|
45
|
+
af agent stream --agent-id <id> --body @stream.json
|
|
46
|
+
af agent update --agent-id <id> --body @update.json
|
|
47
|
+
af agent delete --agent-id <id>
|
|
49
48
|
```
|
|
50
49
|
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
### Verify
|
|
50
|
+
### Workflows
|
|
54
51
|
|
|
55
52
|
```bash
|
|
56
|
-
|
|
53
|
+
af workflow list --fields id,name,status --json
|
|
54
|
+
af workflow create --body @wf.json --dry-run
|
|
55
|
+
af workflow create --body @wf.json
|
|
56
|
+
af workflow run --workflow-id <id> --input @input.json
|
|
57
|
+
af workflow run-status --workflow-run-id <run_id> --json
|
|
58
|
+
af workflow validate --body @wf.json --local-only
|
|
57
59
|
```
|
|
58
60
|
|
|
59
|
-
|
|
60
|
-
Profile: default
|
|
61
|
-
API Key: present
|
|
62
|
-
Workspace ID: ws-abc123
|
|
63
|
-
Project ID: proj-xyz789
|
|
64
|
-
Config: ~/.agenticflow/auth.json
|
|
65
|
-
```
|
|
61
|
+
### Webhook Gateway
|
|
66
62
|
|
|
67
|
-
|
|
63
|
+
Receive tasks from any platform and route them to AgenticFlow agents:
|
|
68
64
|
|
|
69
65
|
```bash
|
|
70
|
-
|
|
71
|
-
|
|
66
|
+
af gateway serve --channels paperclip,linear,webhook --verbose
|
|
67
|
+
af gateway channels # List available channels
|
|
72
68
|
```
|
|
73
69
|
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
### Cold start
|
|
77
|
-
|
|
70
|
+
**Generic webhook** — any system can send tasks:
|
|
78
71
|
```bash
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
# Prime local template cache for workflow/agent/workforce examples
|
|
84
|
-
agenticflow templates sync --json
|
|
85
|
-
agenticflow templates index --json
|
|
72
|
+
curl -X POST http://localhost:4100/webhook/webhook \
|
|
73
|
+
-H "Content-Type: application/json" \
|
|
74
|
+
-d '{"agent_id":"<id>","message":"Summarize Q4 report"}'
|
|
86
75
|
```
|
|
87
76
|
|
|
88
|
-
|
|
89
|
-
|
|
77
|
+
**Paperclip** — AI company orchestration:
|
|
90
78
|
```bash
|
|
91
|
-
|
|
92
|
-
agenticflow agent get --agent-id <id>
|
|
93
|
-
agenticflow agent create --body <json|@file>
|
|
94
|
-
agenticflow agent update --agent-id <id> --body <json|@file>
|
|
95
|
-
agenticflow agent delete --agent-id <id>
|
|
96
|
-
agenticflow agent stream --agent-id <id> --body <json|@file>
|
|
97
|
-
agenticflow agent reference-impact --agent-id <id>
|
|
79
|
+
af gateway serve --channels paperclip
|
|
98
80
|
```
|
|
99
81
|
|
|
100
|
-
|
|
101
|
-
|
|
82
|
+
**Linear** — engineering project management:
|
|
102
83
|
```bash
|
|
103
|
-
|
|
104
|
-
agenticflow workflow get --workflow-id <id>
|
|
105
|
-
agenticflow workflow create --body <json|@file> [--workspace-id <id>]
|
|
106
|
-
agenticflow workflow update --workflow-id <id> --body <json|@file> [--workspace-id <id>]
|
|
107
|
-
agenticflow workflow delete --workflow-id <id> [--workspace-id <id>]
|
|
108
|
-
agenticflow workflow run --workflow-id <id> [--input <json|@file>]
|
|
109
|
-
agenticflow workflow run-status --workflow-run-id <id>
|
|
110
|
-
agenticflow workflow list-runs --workflow-id <id> [--sort-order asc|desc]
|
|
111
|
-
agenticflow workflow run-history --workflow-id <id>
|
|
112
|
-
agenticflow workflow validate --body <json|@file> [--local-only]
|
|
113
|
-
agenticflow workflow reference-impact --workflow-id <id>
|
|
114
|
-
agenticflow workflow like-status --workflow-id <id>
|
|
84
|
+
af gateway serve --channels linear
|
|
115
85
|
```
|
|
116
86
|
|
|
117
|
-
###
|
|
118
|
-
|
|
119
|
-
```bash
|
|
120
|
-
agenticflow connections list [--workspace-id <id>] [--project-id <id>]
|
|
121
|
-
agenticflow connections create --body <json|@file> [--workspace-id <id>]
|
|
122
|
-
agenticflow connections update --connection-id <id> --body <json|@file> [--workspace-id <id>]
|
|
123
|
-
agenticflow connections delete --connection-id <id> [--workspace-id <id>]
|
|
124
|
-
```
|
|
87
|
+
### Paperclip Integration
|
|
125
88
|
|
|
126
|
-
|
|
89
|
+
Deploy agents to [Paperclip](https://github.com/paperclipai/paperclip) companies:
|
|
127
90
|
|
|
128
91
|
```bash
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
92
|
+
af paperclip company create --name "My Company" --budget 100000
|
|
93
|
+
af paperclip deploy --agent-id <id> --role engineer
|
|
94
|
+
af paperclip goal create --title "Build the product" --level company
|
|
95
|
+
af paperclip issue create --title "Design landing page" --assignee <agent-id>
|
|
96
|
+
af paperclip connect # Wire agents to gateway
|
|
97
|
+
af paperclip agent wakeup --id <id> # Trigger execution
|
|
98
|
+
af paperclip dashboard # Monitor
|
|
133
99
|
```
|
|
134
100
|
|
|
135
|
-
###
|
|
101
|
+
### AI-Agent Discovery
|
|
136
102
|
|
|
137
103
|
```bash
|
|
138
|
-
|
|
139
|
-
|
|
104
|
+
af context --json # Bootstrap guide with invariants and schemas
|
|
105
|
+
af schema agent # Payload schema with examples
|
|
106
|
+
af schema --json # List all resource schemas
|
|
107
|
+
af discover --json # Full capability index
|
|
108
|
+
af playbook quickstart # Step-by-step guide
|
|
140
109
|
```
|
|
141
110
|
|
|
142
|
-
###
|
|
143
|
-
|
|
144
|
-
For any endpoint not covered by resource commands:
|
|
111
|
+
### Node Types & Connections
|
|
145
112
|
|
|
146
113
|
```bash
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
# By method + path
|
|
151
|
-
agenticflow call --method GET --path /v1/agents/
|
|
152
|
-
|
|
153
|
-
# With parameters and body
|
|
154
|
-
agenticflow call --operation-id update_v1_agents__agent_id__put \
|
|
155
|
-
-P agent_id=abc123 \
|
|
156
|
-
--body '{"name": "Updated"}'
|
|
157
|
-
|
|
158
|
-
# Query parameters
|
|
159
|
-
agenticflow call --method GET --path /v1/agents/ -Q limit=10
|
|
160
|
-
|
|
161
|
-
# Dry run (shows request without executing)
|
|
162
|
-
agenticflow call --operation-id get_all_v1_agents__get --dry-run
|
|
114
|
+
af node-types search --query "llm" --json
|
|
115
|
+
af node-types get --name <name> --json
|
|
116
|
+
af connections list --limit 200 --json
|
|
163
117
|
```
|
|
164
118
|
|
|
165
|
-
###
|
|
119
|
+
### Playbooks
|
|
166
120
|
|
|
167
121
|
```bash
|
|
168
|
-
#
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
#
|
|
175
|
-
agenticflow ops list [--public-only] [--tag <tag>] [--json]
|
|
176
|
-
agenticflow ops show <operation-id>
|
|
177
|
-
|
|
178
|
-
# Operation catalog
|
|
179
|
-
agenticflow catalog export [--public-only]
|
|
180
|
-
agenticflow catalog rank --task "send a message" [--top <n>]
|
|
181
|
-
|
|
182
|
-
# Policy guardrails
|
|
183
|
-
agenticflow policy show
|
|
184
|
-
agenticflow policy init [--spend-ceiling <amount>]
|
|
185
|
-
|
|
186
|
-
# Built-in playbooks
|
|
187
|
-
agenticflow playbook [topic] [--list]
|
|
188
|
-
# First-touch onboarding for cold agents
|
|
189
|
-
agenticflow playbook first-touch
|
|
190
|
-
agenticflow playbook --list --json
|
|
191
|
-
|
|
192
|
-
# Template bootstrap cache for cold agents
|
|
193
|
-
agenticflow templates sync [--dir .agenticflow/templates] [--limit 100] [--strict] [--json]
|
|
194
|
-
agenticflow templates index [--dir .agenticflow/templates] [--json]
|
|
195
|
-
|
|
196
|
-
# Duplicate resources from templates (web-like flow)
|
|
197
|
-
agenticflow templates duplicate workflow --template-id <workflow_template_id> --json
|
|
198
|
-
agenticflow templates duplicate agent --template-id <agent_template_id> --json
|
|
199
|
-
# Build payloads only (no create)
|
|
200
|
-
agenticflow templates duplicate workflow --template-id <id> --dry-run --json
|
|
201
|
-
# Resolve template IDs from local cache first (cold/sandbox-friendly)
|
|
202
|
-
agenticflow templates duplicate workflow --template-id <id> --cache-dir .agenticflow/templates --json
|
|
203
|
-
agenticflow templates duplicate agent --template-file .agenticflow/templates/agent/<file>.json --cache-dir .agenticflow/templates --dry-run --json
|
|
122
|
+
af playbook quickstart # Zero to working agent in 5 min
|
|
123
|
+
af playbook gateway-setup # Webhook gateway setup
|
|
124
|
+
af playbook deploy-to-paperclip # Paperclip company setup
|
|
125
|
+
af playbook agent-channels # Connect Linear, webhooks, etc.
|
|
126
|
+
af playbook agent-build # Agent configuration
|
|
127
|
+
af playbook workflow-build # Workflow design
|
|
128
|
+
af playbook template-bootstrap # Start from templates
|
|
204
129
|
```
|
|
205
130
|
|
|
206
131
|
## Global Options
|
|
207
132
|
|
|
208
|
-
| Flag |
|
|
209
|
-
|
|
210
|
-
| `--
|
|
211
|
-
| `--
|
|
212
|
-
| `--
|
|
213
|
-
| `--
|
|
214
|
-
| `--
|
|
215
|
-
| `--
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
Create/update/run/stream commands perform local payload validation first. This returns `local_schema_validation_failed` immediately for malformed inputs, before any API request is sent.
|
|
224
|
-
|
|
225
|
-
`templates duplicate` can resolve workflow templates from a local `templates sync` cache via `--cache-dir` before attempting API fetches. This improves cold-start behavior in restricted environments.
|
|
226
|
-
|
|
227
|
-
```bash
|
|
228
|
-
agenticflow agent list | jq '.[] | .name'
|
|
229
|
-
```
|
|
133
|
+
| Flag | Purpose |
|
|
134
|
+
|------|---------|
|
|
135
|
+
| `--json` | Machine-readable JSON output |
|
|
136
|
+
| `--fields <fields>` | Filter output fields (saves context window) |
|
|
137
|
+
| `--dry-run` | Validate without executing |
|
|
138
|
+
| `--api-key <key>` | Override API key |
|
|
139
|
+
| `--workspace-id <id>` | Override workspace |
|
|
140
|
+
| `--project-id <id>` | Override project |
|
|
141
|
+
|
|
142
|
+
## Links
|
|
143
|
+
|
|
144
|
+
- [AgenticFlow Platform](https://agenticflow.ai)
|
|
145
|
+
- [Documentation](https://docs.agenticflow.ai)
|
|
146
|
+
- [SDK Package](https://www.npmjs.com/package/@pixelml/agenticflow-sdk)
|
|
147
|
+
- [GitHub](https://github.com/PixelML/agenticflow-cli)
|
|
230
148
|
|
|
231
149
|
## License
|
|
232
150
|
|