@llm-dev-ops/agentics-cli 1.0.0 → 1.0.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 +222 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1 +1,222 @@
|
|
|
1
|
-
# agentics-cli
|
|
1
|
+
# @llm-dev-ops/agentics-cli
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@llm-dev-ops/agentics-cli)
|
|
4
|
+
[](https://opensource.org/licenses/MIT)
|
|
5
|
+
|
|
6
|
+
CLI for the Agentics Platform - orchestrate simulations, analyze ROI, and deploy AI agent infrastructure.
|
|
7
|
+
|
|
8
|
+
## Installation
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
npm install -g @llm-dev-ops/agentics-cli
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Or run directly with npx:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npx @llm-dev-ops/agentics-cli --help
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Quick Start
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
# Create a simulation plan
|
|
24
|
+
agentics plan "production-deployment"
|
|
25
|
+
|
|
26
|
+
# Run simulation
|
|
27
|
+
agentics simulate '{"id":"plan-123"}' --iterations 10
|
|
28
|
+
|
|
29
|
+
# Inspect results
|
|
30
|
+
agentics inspect '{"id":"sim-456"}' --output-type metrics
|
|
31
|
+
|
|
32
|
+
# Generate ROI report
|
|
33
|
+
agentics quantify '{"id":"sim-456"}' --report-type cfo-grade
|
|
34
|
+
|
|
35
|
+
# Deploy
|
|
36
|
+
agentics deploy '{"id":"sim-456"}' --environment staging
|
|
37
|
+
|
|
38
|
+
# Export infrastructure
|
|
39
|
+
agentics export '{"id":"intent-789"}' --export-format terraform
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Workflow
|
|
43
|
+
|
|
44
|
+
The CLI follows a structured pipeline for AI agent deployment:
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
plan → simulate → inspect → quantify → deploy → export
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
| Stage | Description | Service |
|
|
51
|
+
|-------|-------------|---------|
|
|
52
|
+
| `plan` | Create simulation plan from org manifest | agentics-simulation-planner |
|
|
53
|
+
| `simulate` | Execute simulation iterations | agentics-simulation-runner |
|
|
54
|
+
| `inspect` | Retrieve simulation outputs | agentics-simulation-engine |
|
|
55
|
+
| `quantify` | Generate CFO-grade ROI analysis | enterprise-roi-engine |
|
|
56
|
+
| `deploy` | Resolve deployment intent | agentics-deployment-intent |
|
|
57
|
+
| `export` | Generate IaC artifacts | agentics-deployment-exporters |
|
|
58
|
+
| `diligence` | Package compliance artifacts | diligence-artifacts |
|
|
59
|
+
|
|
60
|
+
## Commands
|
|
61
|
+
|
|
62
|
+
### plan
|
|
63
|
+
|
|
64
|
+
Create a simulation plan from an organization manifest.
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
agentics plan <manifest-query> [--params <json>]
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### simulate
|
|
71
|
+
|
|
72
|
+
Execute a simulation from a plan reference.
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
agentics simulate <plan-ref> [--config <json>] [--iterations <n>]
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### inspect
|
|
79
|
+
|
|
80
|
+
Retrieve deterministic outputs from a simulation.
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
agentics inspect <sim-ref> [--output-type <type>]
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
Output types: `metrics`, `logs`, `state`, `events`, `summary`, `full`
|
|
87
|
+
|
|
88
|
+
### quantify
|
|
89
|
+
|
|
90
|
+
Generate financial impact and ROI analysis.
|
|
91
|
+
|
|
92
|
+
```bash
|
|
93
|
+
agentics quantify <sim-ref> [--report-type <type>] [--params <json>]
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Report types: `executive-summary`, `detailed-analysis`, `cfo-grade`, `custom`
|
|
97
|
+
|
|
98
|
+
### deploy
|
|
99
|
+
|
|
100
|
+
Resolve deployment intent from simulation results.
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
agentics deploy <sim-ref> [--spec <json>] [--environment <env>]
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### export
|
|
107
|
+
|
|
108
|
+
Generate infrastructure-as-code deployment artifacts.
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
agentics export <intent-ref> [--export-format <format>] [--output <path>]
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
Export formats: `terraform`, `kubernetes`, `cloudformation`, `pulumi`, `ansible`, `custom`
|
|
115
|
+
|
|
116
|
+
### diligence
|
|
117
|
+
|
|
118
|
+
Package compliance and audit artifacts.
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
agentics diligence <refs> [--frameworks <list>] [--requirements <json>]
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
Frameworks: `SOC2`, `HIPAA`, `GDPR`, `PCI-DSS`, `custom`
|
|
125
|
+
|
|
126
|
+
## Global Options
|
|
127
|
+
|
|
128
|
+
| Option | Description |
|
|
129
|
+
|--------|-------------|
|
|
130
|
+
| `--timeout <ms>` | Request timeout in milliseconds |
|
|
131
|
+
| `--trace-id <id>` | Correlation ID for distributed tracing |
|
|
132
|
+
| `--format <fmt>` | Output format: `json`, `yaml`, `table`, `text`, `csv` |
|
|
133
|
+
| `--verbose, -v` | Enable verbose output |
|
|
134
|
+
| `--pretty` | Pretty-print output |
|
|
135
|
+
| `--help, -h` | Show help |
|
|
136
|
+
| `--version` | Show version |
|
|
137
|
+
|
|
138
|
+
## Environment Variables
|
|
139
|
+
|
|
140
|
+
Override default service endpoints:
|
|
141
|
+
|
|
142
|
+
| Variable | Service |
|
|
143
|
+
|----------|---------|
|
|
144
|
+
| `AGENTICS_MANIFESTS_URL` | Organization manifests |
|
|
145
|
+
| `AGENTICS_PLANNER_URL` | Simulation planner |
|
|
146
|
+
| `AGENTICS_RUNNER_URL` | Simulation runner |
|
|
147
|
+
| `AGENTICS_SIMULATION_ENGINE_URL` | Simulation engine |
|
|
148
|
+
| `ENTERPRISE_ROI_ENGINE_URL` | ROI engine |
|
|
149
|
+
| `AGENTICS_INTENT_URL` | Deployment intent |
|
|
150
|
+
| `AGENTICS_EXPORTERS_URL` | Deployment exporters |
|
|
151
|
+
| `DILIGENCE_URL` | Diligence artifacts |
|
|
152
|
+
|
|
153
|
+
## Exit Codes
|
|
154
|
+
|
|
155
|
+
| Code | Description |
|
|
156
|
+
|------|-------------|
|
|
157
|
+
| 0 | Success |
|
|
158
|
+
| 1 | General error |
|
|
159
|
+
| 64 | Usage error |
|
|
160
|
+
| 65 | Data format error |
|
|
161
|
+
| 69 | Service unavailable |
|
|
162
|
+
| 70 | Internal error |
|
|
163
|
+
| 100 | Argument validation error |
|
|
164
|
+
| 120 | Network error |
|
|
165
|
+
| 130 | Authentication error |
|
|
166
|
+
| 140 | Service error |
|
|
167
|
+
|
|
168
|
+
## Examples
|
|
169
|
+
|
|
170
|
+
### Full Workflow
|
|
171
|
+
|
|
172
|
+
```bash
|
|
173
|
+
# 1. Create plan for production deployment
|
|
174
|
+
agentics plan "prod-cluster-v2" --params '{"region":"us-east-1"}'
|
|
175
|
+
|
|
176
|
+
# 2. Run 10 simulation iterations
|
|
177
|
+
agentics simulate '{"id":"plan-abc123","type":"PlanReference"}' \
|
|
178
|
+
--iterations 10 \
|
|
179
|
+
--config '{"parallelism":4}'
|
|
180
|
+
|
|
181
|
+
# 3. Get simulation metrics
|
|
182
|
+
agentics inspect '{"id":"sim-xyz789"}' --output-type metrics --format table
|
|
183
|
+
|
|
184
|
+
# 4. Generate CFO report
|
|
185
|
+
agentics quantify '{"id":"sim-xyz789"}' \
|
|
186
|
+
--report-type cfo-grade \
|
|
187
|
+
--params '{"currency":"USD","timeframe":"annual"}'
|
|
188
|
+
|
|
189
|
+
# 5. Deploy to staging
|
|
190
|
+
agentics deploy '{"id":"sim-xyz789"}' --environment staging
|
|
191
|
+
|
|
192
|
+
# 6. Export Terraform configs
|
|
193
|
+
agentics export '{"id":"intent-456"}' \
|
|
194
|
+
--export-format terraform \
|
|
195
|
+
--output ./infrastructure/
|
|
196
|
+
|
|
197
|
+
# 7. Package compliance docs
|
|
198
|
+
agentics diligence '[{"id":"sim-xyz789"},{"id":"intent-456"}]' \
|
|
199
|
+
--frameworks SOC2,HIPAA
|
|
200
|
+
```
|
|
201
|
+
|
|
202
|
+
### JSON Output for Scripting
|
|
203
|
+
|
|
204
|
+
```bash
|
|
205
|
+
# Get simulation ID from plan
|
|
206
|
+
PLAN_REF=$(agentics plan "my-deployment" --format json)
|
|
207
|
+
SIM_REF=$(agentics simulate "$PLAN_REF" --format json)
|
|
208
|
+
agentics quantify "$SIM_REF" --report-type executive-summary
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
## Platform
|
|
212
|
+
|
|
213
|
+
For API key management and interactive workflows, visit:
|
|
214
|
+
**https://platform.agentics.org**
|
|
215
|
+
|
|
216
|
+
## Requirements
|
|
217
|
+
|
|
218
|
+
- Node.js >= 18.0.0
|
|
219
|
+
|
|
220
|
+
## License
|
|
221
|
+
|
|
222
|
+
MIT
|