@elevasis/sdk 0.5.13 → 0.5.15
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/dist/cli.cjs +745 -409
- package/dist/index.d.ts +32 -0
- package/dist/index.js +68 -0
- package/dist/templates.js +254 -37
- package/dist/worker/index.js +3 -7
- package/package.json +1 -1
- package/reference/cli.mdx +568 -505
- package/reference/concepts.mdx +4 -43
- package/reference/deployment/api.mdx +297 -297
- package/reference/deployment/command-center.mdx +9 -12
- package/reference/deployment/index.mdx +7 -7
- package/reference/framework/agent.mdx +6 -18
- package/reference/framework/interaction-guidance.mdx +182 -182
- package/reference/framework/memory.mdx +3 -24
- package/reference/framework/project-structure.mdx +277 -298
- package/reference/framework/tutorial-system.mdx +13 -44
- package/reference/getting-started.mdx +152 -148
- package/reference/index.mdx +28 -14
- package/reference/platform-tools/adapters.mdx +868 -1072
- package/reference/platform-tools/index.mdx +3 -3
- package/reference/resources/index.mdx +339 -341
- package/reference/resources/patterns.mdx +355 -354
- package/reference/resources/types.mdx +207 -207
- package/reference/roadmap.mdx +163 -147
- package/reference/runtime.mdx +2 -25
- package/reference/troubleshooting.mdx +223 -210
package/reference/cli.mdx
CHANGED
|
@@ -1,505 +1,568 @@
|
|
|
1
|
-
---
|
|
2
|
-
title: CLI Reference
|
|
3
|
-
description: Full reference for every elevasis-sdk CLI command -- scaffold, validate, deploy, execute, and inspect resources
|
|
4
|
-
loadWhen: "Running CLI operations"
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
The `elevasis-sdk` CLI is the primary interface for working with your Elevasis SDK project. Install it as part of `@elevasis/sdk` and use it to scaffold projects, validate resource definitions, deploy to the platform, and inspect execution history.
|
|
8
|
-
|
|
9
|
-
**Installation:**
|
|
10
|
-
|
|
11
|
-
```bash
|
|
12
|
-
pnpm add @elevasis/sdk
|
|
13
|
-
```
|
|
14
|
-
|
|
15
|
-
After installation, the `elevasis-sdk` binary is available in your project's `node_modules/.bin/`. Most commands require `
|
|
16
|
-
|
|
17
|
-
---
|
|
18
|
-
|
|
19
|
-
## elevasis-sdk init
|
|
20
|
-
|
|
21
|
-
Scaffold a new Elevasis SDK project in the specified directory.
|
|
22
|
-
|
|
23
|
-
**Synopsis:**
|
|
24
|
-
|
|
25
|
-
```
|
|
26
|
-
elevasis-sdk init [directory]
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
**Behavior:**
|
|
30
|
-
|
|
31
|
-
- Derives the organization slug from the directory name
|
|
32
|
-
- Checks for file conflicts before writing any files
|
|
33
|
-
- Scaffolds project structure including `src/index.ts`, `elevasis.config.ts`, `package.json`, `tsconfig.json`, and a `CLAUDE.md` with CLI reference and SDK patterns
|
|
34
|
-
- Non-interactive: all values are derived automatically
|
|
35
|
-
|
|
36
|
-
**Flags:**
|
|
37
|
-
|
|
38
|
-
| Flag
|
|
39
|
-
|
|
|
40
|
-
| (none) | Uses current directory if no argument is provided |
|
|
41
|
-
|
|
42
|
-
**Example:**
|
|
43
|
-
|
|
44
|
-
```bash
|
|
45
|
-
elevasis-sdk init my-project
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
You can also run `init` without a global install using `pnpm dlx`:
|
|
49
|
-
|
|
50
|
-
```bash
|
|
51
|
-
pnpm dlx @elevasis/sdk init my-project
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
```
|
|
55
|
-
Scaffolding my-project/...
|
|
56
|
-
|
|
57
|
-
Created
|
|
58
|
-
|
|
59
|
-
Next steps:
|
|
60
|
-
cd my-project
|
|
61
|
-
pnpm install
|
|
62
|
-
elevasis-sdk check
|
|
63
|
-
```
|
|
64
|
-
|
|
65
|
-
---
|
|
66
|
-
|
|
67
|
-
## elevasis-sdk
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
**Synopsis:**
|
|
72
|
-
|
|
73
|
-
```
|
|
74
|
-
elevasis-sdk
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
**Behavior:**
|
|
78
|
-
|
|
79
|
-
-
|
|
80
|
-
-
|
|
81
|
-
|
|
82
|
-
-
|
|
83
|
-
- `
|
|
84
|
-
-
|
|
85
|
-
-
|
|
86
|
-
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
|
92
|
-
|
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
**
|
|
121
|
-
|
|
122
|
-
```
|
|
123
|
-
elevasis-sdk
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
ERROR
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
-
|
|
192
|
-
-
|
|
193
|
-
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
|
201
|
-
|
|
|
202
|
-
| `--api-url <url>` | Override the API base URL |
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
```
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
```
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
```
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
```
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
```
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
1
|
+
---
|
|
2
|
+
title: CLI Reference
|
|
3
|
+
description: Full reference for every elevasis-sdk CLI command -- scaffold, validate, deploy, execute, and inspect resources
|
|
4
|
+
loadWhen: "Running CLI operations"
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
The `elevasis-sdk` CLI is the primary interface for working with your Elevasis SDK project. Install it as part of `@elevasis/sdk` and use it to scaffold projects, validate resource definitions, deploy to the platform, and inspect execution history.
|
|
8
|
+
|
|
9
|
+
**Installation:**
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
pnpm add @elevasis/sdk
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
After installation, the `elevasis-sdk` binary is available in your project's `node_modules/.bin/`. Most commands require `ELEVASIS_PLATFORM_KEY` to be set in your environment or a `.env` file.
|
|
16
|
+
|
|
17
|
+
---
|
|
18
|
+
|
|
19
|
+
## elevasis-sdk init
|
|
20
|
+
|
|
21
|
+
Scaffold a new Elevasis SDK project in the specified directory.
|
|
22
|
+
|
|
23
|
+
**Synopsis:**
|
|
24
|
+
|
|
25
|
+
```
|
|
26
|
+
elevasis-sdk init [directory]
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
**Behavior:**
|
|
30
|
+
|
|
31
|
+
- Derives the organization slug from the directory name
|
|
32
|
+
- Checks for file conflicts before writing any files
|
|
33
|
+
- Scaffolds project structure including `src/index.ts`, `elevasis.config.ts`, `package.json`, `tsconfig.json`, and a `CLAUDE.md` with CLI reference and SDK patterns
|
|
34
|
+
- Non-interactive: all values are derived automatically
|
|
35
|
+
|
|
36
|
+
**Flags:**
|
|
37
|
+
|
|
38
|
+
| Flag | Description |
|
|
39
|
+
| ------ | ------------------------------------------------- |
|
|
40
|
+
| (none) | Uses current directory if no argument is provided |
|
|
41
|
+
|
|
42
|
+
**Example:**
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
elevasis-sdk init my-project
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
You can also run `init` without a global install using `pnpm dlx`:
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
pnpm dlx @elevasis/sdk init my-project
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
```
|
|
55
|
+
Scaffolding my-project/...
|
|
56
|
+
|
|
57
|
+
Created 30 files.
|
|
58
|
+
|
|
59
|
+
Next steps:
|
|
60
|
+
cd my-project
|
|
61
|
+
pnpm install
|
|
62
|
+
elevasis-sdk check
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
## elevasis-sdk update
|
|
68
|
+
|
|
69
|
+
Update managed project files to the latest template version.
|
|
70
|
+
|
|
71
|
+
**Synopsis:**
|
|
72
|
+
|
|
73
|
+
```
|
|
74
|
+
elevasis-sdk update [--ui]
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
**Behavior:**
|
|
78
|
+
|
|
79
|
+
- Reads `elevasis.config.ts` to get the current `templateVersion` and compares it against the latest template version
|
|
80
|
+
- If already up to date (and no `--ui` flag), exits early with a success message
|
|
81
|
+
- For each managed file:
|
|
82
|
+
- Missing files are written directly
|
|
83
|
+
- `.gitignore` uses append-only merge -- new entries are added, existing entries are never removed
|
|
84
|
+
- `elevasis.config.ts` gets only its `templateVersion` field updated
|
|
85
|
+
- `CLAUDE.md` uses section-aware merge -- SDK-owned sections are replaced with the latest template, user-added sections are preserved
|
|
86
|
+
- All other managed files are compared against the template and flagged for review if they differ
|
|
87
|
+
- Pass `--ui` to scaffold a Vite + React UI app in `ui/` (can be combined with a version update or run independently)
|
|
88
|
+
|
|
89
|
+
**Flags:**
|
|
90
|
+
|
|
91
|
+
| Flag | Description |
|
|
92
|
+
| ------ | --------------------------------------- |
|
|
93
|
+
| `--ui` | Add a Vite + React UI scaffold in `ui/` |
|
|
94
|
+
|
|
95
|
+
**Example output (version update):**
|
|
96
|
+
|
|
97
|
+
```
|
|
98
|
+
$ elevasis-sdk update
|
|
99
|
+
|
|
100
|
+
Updated @elevasis/sdk template v24 -> v27
|
|
101
|
+
|
|
102
|
+
Added:
|
|
103
|
+
.env.example
|
|
104
|
+
|
|
105
|
+
Appended to .gitignore:
|
|
106
|
+
ui/dist
|
|
107
|
+
|
|
108
|
+
Needs agent review:
|
|
109
|
+
tsconfig.json (differs from template)
|
|
110
|
+
|
|
111
|
+
CLAUDE.md sections:
|
|
112
|
+
updated: Commands
|
|
113
|
+
updated: Skills
|
|
114
|
+
preserved: Custom Workflows
|
|
115
|
+
|
|
116
|
+
Run /meta update in Claude Code to merge flagged files.
|
|
117
|
+
Or run /meta fix to verify and repair the full framework.
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
**Example output (already up to date):**
|
|
121
|
+
|
|
122
|
+
```
|
|
123
|
+
$ elevasis-sdk update
|
|
124
|
+
|
|
125
|
+
Project is up to date (template version 27)
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## elevasis-sdk check
|
|
131
|
+
|
|
132
|
+
Validate all resource definitions in your project without deploying.
|
|
133
|
+
|
|
134
|
+
**Synopsis:**
|
|
135
|
+
|
|
136
|
+
```
|
|
137
|
+
elevasis-sdk check
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
**Behavior:**
|
|
141
|
+
|
|
142
|
+
- Imports your `src/index.ts` and runs it through `ResourceRegistry` validation
|
|
143
|
+
- Catches the same errors that the platform catches at deploy time:
|
|
144
|
+
- Duplicate `resourceId` within the organization
|
|
145
|
+
- Invalid model configuration (temperature and token bounds)
|
|
146
|
+
- `ExecutionInterface` form fields not matching `inputSchema`
|
|
147
|
+
- Broken workflow step chains (`next` referencing non-existent steps)
|
|
148
|
+
- Relationship declarations referencing non-existent resources
|
|
149
|
+
- Exits with code 0 on success, code 1 on validation failure
|
|
150
|
+
|
|
151
|
+
**Flags:**
|
|
152
|
+
|
|
153
|
+
| Flag | Description |
|
|
154
|
+
| ------------------- | ------------------------- |
|
|
155
|
+
| `--api-url <url>` | Override the API base URL |
|
|
156
|
+
|
|
157
|
+
**Example output (success):**
|
|
158
|
+
|
|
159
|
+
```
|
|
160
|
+
$ elevasis-sdk check
|
|
161
|
+
|
|
162
|
+
Validating... done (4 resources, 0 errors)
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
**Example output (failure):**
|
|
166
|
+
|
|
167
|
+
```
|
|
168
|
+
$ elevasis-sdk check
|
|
169
|
+
|
|
170
|
+
Validating...
|
|
171
|
+
ERROR Duplicate resource ID 'onboard-client' in organization 'Acme Corp'
|
|
172
|
+
ERROR Workflow step 'send-email' references non-existent next step 'notify'
|
|
173
|
+
|
|
174
|
+
2 errors.
|
|
175
|
+
```
|
|
176
|
+
|
|
177
|
+
---
|
|
178
|
+
|
|
179
|
+
## elevasis-sdk deploy
|
|
180
|
+
|
|
181
|
+
Bundle your project with esbuild and deploy it to the Elevasis platform.
|
|
182
|
+
|
|
183
|
+
**Synopsis:**
|
|
184
|
+
|
|
185
|
+
```
|
|
186
|
+
elevasis-sdk deploy
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
**Behavior:**
|
|
190
|
+
|
|
191
|
+
- Authenticates with `ELEVASIS_PLATFORM_KEY` and resolves your organization name
|
|
192
|
+
- Runs the same `ResourceRegistry` validation as `elevasis-sdk check`
|
|
193
|
+
- Bundles your `src/index.ts` and all dependencies into a single self-contained JS file (`dist/bundle.js`, approximately 50-200 KB)
|
|
194
|
+
- Uploads the bundle plus resource metadata to `POST /api/external/deploy`
|
|
195
|
+
- Streams deploy status and prints the result
|
|
196
|
+
- Resources are live immediately after a successful deploy
|
|
197
|
+
|
|
198
|
+
**Flags:**
|
|
199
|
+
|
|
200
|
+
| Flag | Description |
|
|
201
|
+
| ------------------- | ------------------------------------------------------------------------- |
|
|
202
|
+
| `--api-url <url>` | Override the API base URL (default: production) |
|
|
203
|
+
| `--prod` | Force production target, overriding `NODE_ENV=development` (internal use) |
|
|
204
|
+
|
|
205
|
+
**Environment variables:**
|
|
206
|
+
|
|
207
|
+
| Variable | Description |
|
|
208
|
+
| ----------------------- | ----------------------------------- |
|
|
209
|
+
| `ELEVASIS_PLATFORM_KEY` | Required. Your `sk_...` API key |
|
|
210
|
+
| `ELEVASIS_API_URL` | Optional. Override the API base URL |
|
|
211
|
+
|
|
212
|
+
**Example output (success):**
|
|
213
|
+
|
|
214
|
+
```
|
|
215
|
+
$ elevasis-sdk deploy
|
|
216
|
+
|
|
217
|
+
Authenticating... done (acme-corp)
|
|
218
|
+
Validating... done (4 resources, 0 errors)
|
|
219
|
+
Bundling... done (142 KB)
|
|
220
|
+
Uploading... done
|
|
221
|
+
|
|
222
|
+
Deployed! 4 resources live.
|
|
223
|
+
Deployment: deploy_abc123
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
**Example output (validation failure):**
|
|
227
|
+
|
|
228
|
+
```
|
|
229
|
+
$ elevasis-sdk deploy
|
|
230
|
+
|
|
231
|
+
Authenticating... done (acme-corp)
|
|
232
|
+
Validating...
|
|
233
|
+
ERROR Duplicate resource ID 'onboard-client' in organization 'Acme Corp'
|
|
234
|
+
ERROR Workflow step 'send-email' references non-existent next step 'notify'
|
|
235
|
+
|
|
236
|
+
2 errors. Deploy aborted.
|
|
237
|
+
```
|
|
238
|
+
|
|
239
|
+
---
|
|
240
|
+
|
|
241
|
+
## elevasis-sdk exec
|
|
242
|
+
|
|
243
|
+
Execute a deployed resource by ID.
|
|
244
|
+
|
|
245
|
+
**Synopsis:**
|
|
246
|
+
|
|
247
|
+
```
|
|
248
|
+
elevasis-sdk exec <resource> --input '{...}'
|
|
249
|
+
```
|
|
250
|
+
|
|
251
|
+
**Behavior:**
|
|
252
|
+
|
|
253
|
+
- Executes the named resource synchronously by default and streams the result
|
|
254
|
+
- Use `--async` to return an `executionId` immediately and poll for completion
|
|
255
|
+
- `--input` accepts a JSON string matching the resource's `inputSchema`
|
|
256
|
+
- Organization is derived from your API key -- no org prefix needed
|
|
257
|
+
|
|
258
|
+
**Flags:**
|
|
259
|
+
|
|
260
|
+
| Flag | Description |
|
|
261
|
+
| ------------------- | ------------------------------------------------------- |
|
|
262
|
+
| `--input <json>` | JSON input matching the resource's input schema |
|
|
263
|
+
| `--async` | Execute asynchronously, return execution ID immediately |
|
|
264
|
+
| `--json` | Output raw JSON instead of formatted display |
|
|
265
|
+
| `--api-url <url>` | Override the API base URL |
|
|
266
|
+
|
|
267
|
+
**Example:**
|
|
268
|
+
|
|
269
|
+
```bash
|
|
270
|
+
elevasis-sdk exec onboard-client --input '{"clientName": "Jane", "email": "jane@example.com"}'
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
```
|
|
274
|
+
Executing onboard-client...
|
|
275
|
+
|
|
276
|
+
Status: completed
|
|
277
|
+
Duration: 1.4s
|
|
278
|
+
|
|
279
|
+
Output:
|
|
280
|
+
{
|
|
281
|
+
"success": true,
|
|
282
|
+
"clientId": "client_1708521600000",
|
|
283
|
+
"welcomeEmailSent": true
|
|
284
|
+
}
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
**Async example:**
|
|
288
|
+
|
|
289
|
+
```bash
|
|
290
|
+
elevasis-sdk exec onboard-client --input '{"clientName": "Jane"}' --async
|
|
291
|
+
```
|
|
292
|
+
|
|
293
|
+
```
|
|
294
|
+
Execution started: exec_550e8400
|
|
295
|
+
Poll with: elevasis-sdk execution onboard-client exec_550e8400
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
---
|
|
299
|
+
|
|
300
|
+
## elevasis-sdk resources
|
|
301
|
+
|
|
302
|
+
List all deployed resources for your organization.
|
|
303
|
+
|
|
304
|
+
**Synopsis:**
|
|
305
|
+
|
|
306
|
+
```
|
|
307
|
+
elevasis-sdk resources
|
|
308
|
+
```
|
|
309
|
+
|
|
310
|
+
**Behavior:**
|
|
311
|
+
|
|
312
|
+
- Lists all resources registered to your organization on the platform
|
|
313
|
+
- In production, only `status: 'prod'` resources are shown
|
|
314
|
+
- Displays resource ID, type, name, and status
|
|
315
|
+
|
|
316
|
+
**Flags:**
|
|
317
|
+
|
|
318
|
+
| Flag | Description |
|
|
319
|
+
| ------------------- | ------------------------- |
|
|
320
|
+
| `--json` | Output raw JSON |
|
|
321
|
+
| `--api-url <url>` | Override the API base URL |
|
|
322
|
+
|
|
323
|
+
**Example output:**
|
|
324
|
+
|
|
325
|
+
```
|
|
326
|
+
$ elevasis-sdk resources
|
|
327
|
+
|
|
328
|
+
onboard-client workflow Onboard Client prod
|
|
329
|
+
send-report workflow Send Weekly Report prod
|
|
330
|
+
email-assistant agent Email Assistant prod
|
|
331
|
+
support-bot agent Support Bot dev
|
|
332
|
+
```
|
|
333
|
+
|
|
334
|
+
---
|
|
335
|
+
|
|
336
|
+
## elevasis-sdk executions
|
|
337
|
+
|
|
338
|
+
View execution history for a resource.
|
|
339
|
+
|
|
340
|
+
**Synopsis:**
|
|
341
|
+
|
|
342
|
+
```
|
|
343
|
+
elevasis-sdk executions [resource]
|
|
344
|
+
```
|
|
345
|
+
|
|
346
|
+
**Behavior:**
|
|
347
|
+
|
|
348
|
+
- Lists recent executions for the specified resource
|
|
349
|
+
- If `resource` is omitted, lists executions across all resources
|
|
350
|
+
- Supports filtering by status and limiting result count
|
|
351
|
+
|
|
352
|
+
**Flags:**
|
|
353
|
+
|
|
354
|
+
| Flag | Description |
|
|
355
|
+
| --------------------- | --------------------------------------------------------------- |
|
|
356
|
+
| `--limit <n>` | Maximum number of executions to return (default: 20) |
|
|
357
|
+
| `--status <status>` | Filter by status: `running`, `completed`, `failed`, `cancelled` |
|
|
358
|
+
| `--json` | Output raw JSON |
|
|
359
|
+
| `--api-url <url>` | Override the API base URL |
|
|
360
|
+
|
|
361
|
+
**Example:**
|
|
362
|
+
|
|
363
|
+
```bash
|
|
364
|
+
elevasis-sdk executions onboard-client --limit 5
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
```
|
|
368
|
+
exec_abc001 completed 2026-02-25 14:32:01 1.2s
|
|
369
|
+
exec_abc002 completed 2026-02-25 13:18:44 0.9s
|
|
370
|
+
exec_abc003 failed 2026-02-25 12:05:22 0.3s
|
|
371
|
+
exec_abc004 completed 2026-02-24 17:51:09 1.8s
|
|
372
|
+
exec_abc005 completed 2026-02-24 16:30:55 1.1s
|
|
373
|
+
```
|
|
374
|
+
|
|
375
|
+
---
|
|
376
|
+
|
|
377
|
+
## elevasis-sdk execution
|
|
378
|
+
|
|
379
|
+
View full detail for a single execution.
|
|
380
|
+
|
|
381
|
+
**Synopsis:**
|
|
382
|
+
|
|
383
|
+
```
|
|
384
|
+
elevasis-sdk execution <resource> <id>
|
|
385
|
+
```
|
|
386
|
+
|
|
387
|
+
**Behavior:**
|
|
388
|
+
|
|
389
|
+
- Shows the complete execution record: input, output, logs, duration, and error (if any)
|
|
390
|
+
- Use `--json` to get the raw JSON response for programmatic use
|
|
391
|
+
|
|
392
|
+
**Flags:**
|
|
393
|
+
|
|
394
|
+
| Flag | Description |
|
|
395
|
+
| ------------------- | ------------------------- |
|
|
396
|
+
| `--json` | Output raw JSON |
|
|
397
|
+
| `--api-url <url>` | Override the API base URL |
|
|
398
|
+
|
|
399
|
+
**Example:**
|
|
400
|
+
|
|
401
|
+
```bash
|
|
402
|
+
elevasis-sdk execution onboard-client exec_abc001
|
|
403
|
+
```
|
|
404
|
+
|
|
405
|
+
```
|
|
406
|
+
Resource: onboard-client
|
|
407
|
+
Status: completed
|
|
408
|
+
Started: 2026-02-25 14:32:01
|
|
409
|
+
Duration: 1.2s
|
|
410
|
+
|
|
411
|
+
Input:
|
|
412
|
+
{
|
|
413
|
+
"clientName": "Jane",
|
|
414
|
+
"email": "jane@example.com"
|
|
415
|
+
}
|
|
416
|
+
|
|
417
|
+
Output:
|
|
418
|
+
{
|
|
419
|
+
"success": true,
|
|
420
|
+
"clientId": "client_1708521600000",
|
|
421
|
+
"welcomeEmailSent": true
|
|
422
|
+
}
|
|
423
|
+
|
|
424
|
+
Logs:
|
|
425
|
+
[14:32:01.123] Starting onboard-client workflow
|
|
426
|
+
[14:32:01.456] Created client record
|
|
427
|
+
[14:32:01.891] Welcome email sent to jane@example.com
|
|
428
|
+
```
|
|
429
|
+
|
|
430
|
+
---
|
|
431
|
+
|
|
432
|
+
## elevasis-sdk deployments
|
|
433
|
+
|
|
434
|
+
List all deployments for your organization.
|
|
435
|
+
|
|
436
|
+
**Synopsis:**
|
|
437
|
+
|
|
438
|
+
```
|
|
439
|
+
elevasis-sdk deployments
|
|
440
|
+
```
|
|
441
|
+
|
|
442
|
+
**Behavior:**
|
|
443
|
+
|
|
444
|
+
- Shows deployment history with status, timestamp, and resource count
|
|
445
|
+
- Active deployment is marked; previous deployments show as `stopped`
|
|
446
|
+
|
|
447
|
+
**Flags:**
|
|
448
|
+
|
|
449
|
+
| Flag | Description |
|
|
450
|
+
| ------------------- | ------------------------- |
|
|
451
|
+
| `--json` | Output raw JSON |
|
|
452
|
+
| `--api-url <url>` | Override the API base URL |
|
|
453
|
+
|
|
454
|
+
**Example output:**
|
|
455
|
+
|
|
456
|
+
```
|
|
457
|
+
$ elevasis-sdk deployments
|
|
458
|
+
|
|
459
|
+
deploy_abc123 active 2026-02-25 14:00:00 4 resources
|
|
460
|
+
deploy_abc122 stopped 2026-02-24 09:30:00 3 resources
|
|
461
|
+
deploy_abc121 stopped 2026-02-23 11:15:00 3 resources
|
|
462
|
+
```
|
|
463
|
+
|
|
464
|
+
---
|
|
465
|
+
|
|
466
|
+
## elevasis-sdk describe
|
|
467
|
+
|
|
468
|
+
Show the definition of a deployed resource.
|
|
469
|
+
|
|
470
|
+
**Synopsis:**
|
|
471
|
+
|
|
472
|
+
```
|
|
473
|
+
elevasis-sdk describe <resource>
|
|
474
|
+
```
|
|
475
|
+
|
|
476
|
+
**Behavior:**
|
|
477
|
+
|
|
478
|
+
- Displays resource metadata: name, type, description, status, and domains
|
|
479
|
+
- Shows the full `inputSchema` and `outputSchema` as JSON
|
|
480
|
+
- Type is color-coded: yellow for workflows, magenta for agents
|
|
481
|
+
|
|
482
|
+
**Flags:**
|
|
483
|
+
|
|
484
|
+
| Flag | Description |
|
|
485
|
+
| ------------------- | ------------------------- |
|
|
486
|
+
| `--json` | Output raw JSON response |
|
|
487
|
+
| `--api-url <url>` | Override the API base URL |
|
|
488
|
+
|
|
489
|
+
**Example:**
|
|
490
|
+
|
|
491
|
+
```bash
|
|
492
|
+
elevasis-sdk describe onboard-client
|
|
493
|
+
```
|
|
494
|
+
|
|
495
|
+
```
|
|
496
|
+
onboard-client [workflow]
|
|
497
|
+
|
|
498
|
+
Name: Onboard Client
|
|
499
|
+
Description: Creates a client record and sends a welcome email
|
|
500
|
+
Status: prod
|
|
501
|
+
Domains: crm, email
|
|
502
|
+
|
|
503
|
+
Input Schema:
|
|
504
|
+
{
|
|
505
|
+
"type": "object",
|
|
506
|
+
"properties": {
|
|
507
|
+
"clientName": { "type": "string" },
|
|
508
|
+
"email": { "type": "string", "format": "email" }
|
|
509
|
+
},
|
|
510
|
+
"required": ["clientName", "email"]
|
|
511
|
+
}
|
|
512
|
+
```
|
|
513
|
+
|
|
514
|
+
---
|
|
515
|
+
|
|
516
|
+
## elevasis-sdk env
|
|
517
|
+
|
|
518
|
+
Manage environment variables for your project.
|
|
519
|
+
|
|
520
|
+
**Synopsis:**
|
|
521
|
+
|
|
522
|
+
```
|
|
523
|
+
elevasis-sdk env list
|
|
524
|
+
elevasis-sdk env set <key> <value>
|
|
525
|
+
elevasis-sdk env remove <key>
|
|
526
|
+
```
|
|
527
|
+
|
|
528
|
+
**Behavior:**
|
|
529
|
+
|
|
530
|
+
- `list` -- display all environment variables configured for the project
|
|
531
|
+
- `set` -- add or update an environment variable
|
|
532
|
+
- `remove` -- delete an environment variable
|
|
533
|
+
|
|
534
|
+
**Flags:**
|
|
535
|
+
|
|
536
|
+
| Flag | Description |
|
|
537
|
+
| ------------------- | ------------------------- |
|
|
538
|
+
| `--api-url <url>` | Override the API base URL |
|
|
539
|
+
|
|
540
|
+
**Examples:**
|
|
541
|
+
|
|
542
|
+
```bash
|
|
543
|
+
elevasis-sdk env list
|
|
544
|
+
elevasis-sdk env set OPENAI_API_KEY sk-proj-***
|
|
545
|
+
elevasis-sdk env remove OPENAI_API_KEY
|
|
546
|
+
```
|
|
547
|
+
|
|
548
|
+
---
|
|
549
|
+
|
|
550
|
+
## Global Flags
|
|
551
|
+
|
|
552
|
+
These flags are accepted by all commands:
|
|
553
|
+
|
|
554
|
+
| Flag | Description |
|
|
555
|
+
| ------------------- | --------------------------------------------------------------------------------------------------- |
|
|
556
|
+
| `--api-url <url>` | Override the API base URL. Priority: flag > `ELEVASIS_API_URL` env var > `NODE_ENV`-based default |
|
|
557
|
+
| `--json` | Output raw JSON (available on most commands) |
|
|
558
|
+
|
|
559
|
+
**API base URL resolution:**
|
|
560
|
+
|
|
561
|
+
- Production (default): `https://api.elevasis.io`
|
|
562
|
+
- Development (`NODE_ENV=development`): `http://localhost:<port>`
|
|
563
|
+
- Override: set `ELEVASIS_API_URL` or pass `--api-url`
|
|
564
|
+
- Force production: pass `--prod` on `deploy` (overrides `NODE_ENV=development`)
|
|
565
|
+
|
|
566
|
+
---
|
|
567
|
+
|
|
568
|
+
**Last Updated:** 2026-03-08
|