@elevasis/sdk 0.5.10 → 0.5.12
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 +249 -280
- package/dist/index.d.ts +3 -4
- package/dist/index.js +5 -29
- package/dist/templates.js +191 -187
- package/dist/worker/index.js +79 -22
- package/package.json +1 -3
- package/reference/_navigation.md +3 -3
- package/reference/cli/index.mdx +51 -45
- package/reference/concepts/index.mdx +2 -2
- package/reference/deployment/api.mdx +8 -8
- package/reference/deployment/command-center-ui.mdx +4 -4
- package/reference/deployment/command-view.mdx +3 -3
- package/reference/deployment/index.mdx +7 -7
- package/reference/framework/agent.mdx +4 -4
- package/reference/framework/documentation.mdx +7 -7
- package/reference/framework/index.mdx +2 -2
- package/reference/framework/memory.mdx +1 -1
- package/reference/framework/project-structure.mdx +20 -30
- package/reference/getting-started/index.mdx +20 -32
- package/reference/index.mdx +6 -5
- package/reference/platform-tools/index.mdx +4 -4
- package/reference/resources/index.mdx +3 -3
- package/reference/resources/patterns.mdx +3 -3
- package/reference/resources/types.mdx +2 -2
- package/reference/roadmap/index.mdx +1 -1
- package/reference/runtime/index.mdx +3 -3
- package/reference/security/credentials.mdx +3 -3
- package/reference/troubleshooting/common-errors.mdx +3 -3
package/dist/worker/index.js
CHANGED
|
@@ -4997,15 +4997,20 @@ function resolveNext(next, data) {
|
|
|
4997
4997
|
}
|
|
4998
4998
|
return next.default;
|
|
4999
4999
|
}
|
|
5000
|
+
function serializeNext(next) {
|
|
5001
|
+
if (next === null) return null;
|
|
5002
|
+
if (next.type === "linear") return { type: "linear", target: next.target };
|
|
5003
|
+
return { type: "conditional", routes: next.routes.map((r) => ({ target: r.target })), default: next.default };
|
|
5004
|
+
}
|
|
5000
5005
|
async function executeWorkflow(workflow, input, context) {
|
|
5001
5006
|
const logs = [];
|
|
5002
|
-
const postLog = (level, message) => {
|
|
5007
|
+
const postLog = (level, message, logContext) => {
|
|
5003
5008
|
const timestamp = (/* @__PURE__ */ new Date()).toISOString();
|
|
5004
|
-
const entry = { level, message, timestamp };
|
|
5009
|
+
const entry = { level, message, timestamp, context: logContext };
|
|
5005
5010
|
logs.push(entry);
|
|
5006
5011
|
parentPort.postMessage({
|
|
5007
5012
|
type: "log",
|
|
5008
|
-
entry: { level, message, timestamp, executionId: context.executionId }
|
|
5013
|
+
entry: { level, message, timestamp, executionId: context.executionId, context: logContext }
|
|
5009
5014
|
});
|
|
5010
5015
|
};
|
|
5011
5016
|
const origLog = console.log;
|
|
@@ -5026,26 +5031,71 @@ async function executeWorkflow(workflow, input, context) {
|
|
|
5026
5031
|
if (!step) {
|
|
5027
5032
|
throw new Error(`Step '${stepId}' not found in workflow '${workflow.config.resourceId}'`);
|
|
5028
5033
|
}
|
|
5034
|
+
const stepStartTime = Date.now();
|
|
5029
5035
|
const stepInput = step.inputSchema.parse(currentData);
|
|
5030
|
-
|
|
5031
|
-
|
|
5032
|
-
|
|
5033
|
-
|
|
5034
|
-
|
|
5035
|
-
|
|
5036
|
-
|
|
5037
|
-
parentExecutionId: context.parentExecutionId,
|
|
5038
|
-
executionDepth: context.executionDepth,
|
|
5039
|
-
store: /* @__PURE__ */ new Map(),
|
|
5040
|
-
logger: {
|
|
5041
|
-
debug: (msg) => console.log(`[debug] ${msg}`),
|
|
5042
|
-
info: (msg) => console.log(`[info] ${msg}`),
|
|
5043
|
-
warn: (msg) => console.warn(`[warn] ${msg}`),
|
|
5044
|
-
error: (msg) => console.error(`[error] ${msg}`)
|
|
5045
|
-
}
|
|
5036
|
+
postLog("info", `Step '${step.name}' started`, {
|
|
5037
|
+
type: "workflow",
|
|
5038
|
+
contextType: "step-started",
|
|
5039
|
+
stepId: step.id,
|
|
5040
|
+
stepStatus: "started",
|
|
5041
|
+
input: stepInput,
|
|
5042
|
+
startTime: stepStartTime
|
|
5046
5043
|
});
|
|
5047
|
-
|
|
5048
|
-
|
|
5044
|
+
try {
|
|
5045
|
+
const rawOutput = await step.handler(stepInput, {
|
|
5046
|
+
executionId: context.executionId,
|
|
5047
|
+
organizationId: context.organizationId,
|
|
5048
|
+
organizationName: context.organizationName,
|
|
5049
|
+
resourceId: workflow.config.resourceId,
|
|
5050
|
+
sessionId: context.sessionId,
|
|
5051
|
+
sessionTurnNumber: context.sessionTurnNumber,
|
|
5052
|
+
parentExecutionId: context.parentExecutionId,
|
|
5053
|
+
executionDepth: context.executionDepth,
|
|
5054
|
+
store: /* @__PURE__ */ new Map(),
|
|
5055
|
+
logger: {
|
|
5056
|
+
debug: (msg) => console.log(`[debug] ${msg}`),
|
|
5057
|
+
info: (msg) => console.log(`[info] ${msg}`),
|
|
5058
|
+
warn: (msg) => console.warn(`[warn] ${msg}`),
|
|
5059
|
+
error: (msg) => console.error(`[error] ${msg}`)
|
|
5060
|
+
}
|
|
5061
|
+
});
|
|
5062
|
+
currentData = step.outputSchema.parse(rawOutput);
|
|
5063
|
+
const stepEndTime = Date.now();
|
|
5064
|
+
const nextStepId = resolveNext(step.next, currentData);
|
|
5065
|
+
postLog("info", `Step '${step.name}' completed (${stepEndTime - stepStartTime}ms)`, {
|
|
5066
|
+
type: "workflow",
|
|
5067
|
+
contextType: "step-completed",
|
|
5068
|
+
stepId: step.id,
|
|
5069
|
+
stepStatus: "completed",
|
|
5070
|
+
output: currentData,
|
|
5071
|
+
duration: stepEndTime - stepStartTime,
|
|
5072
|
+
isTerminal: nextStepId === null,
|
|
5073
|
+
startTime: stepStartTime,
|
|
5074
|
+
endTime: stepEndTime
|
|
5075
|
+
});
|
|
5076
|
+
if (step.next?.type === "conditional" && nextStepId !== null) {
|
|
5077
|
+
postLog("info", `Routing from '${step.name}' to '${nextStepId}'`, {
|
|
5078
|
+
type: "workflow",
|
|
5079
|
+
contextType: "conditional-route",
|
|
5080
|
+
stepId: step.id,
|
|
5081
|
+
target: nextStepId
|
|
5082
|
+
});
|
|
5083
|
+
}
|
|
5084
|
+
stepId = nextStepId;
|
|
5085
|
+
} catch (err) {
|
|
5086
|
+
const stepEndTime = Date.now();
|
|
5087
|
+
postLog("error", `Step '${step.name}' failed: ${String(err)}`, {
|
|
5088
|
+
type: "workflow",
|
|
5089
|
+
contextType: "step-failed",
|
|
5090
|
+
stepId: step.id,
|
|
5091
|
+
stepStatus: "failed",
|
|
5092
|
+
error: String(err),
|
|
5093
|
+
duration: stepEndTime - stepStartTime,
|
|
5094
|
+
startTime: stepStartTime,
|
|
5095
|
+
endTime: stepEndTime
|
|
5096
|
+
});
|
|
5097
|
+
throw err;
|
|
5098
|
+
}
|
|
5049
5099
|
}
|
|
5050
5100
|
if (workflow.contract.outputSchema) {
|
|
5051
5101
|
currentData = workflow.contract.outputSchema.parse(currentData);
|
|
@@ -5122,7 +5172,14 @@ function startWorker(org) {
|
|
|
5122
5172
|
status: w.config.status,
|
|
5123
5173
|
description: w.config.description,
|
|
5124
5174
|
version: w.config.version,
|
|
5125
|
-
domains: w.config.domains
|
|
5175
|
+
domains: w.config.domains,
|
|
5176
|
+
steps: Object.values(w.steps).map((step) => ({
|
|
5177
|
+
id: step.id,
|
|
5178
|
+
name: step.name,
|
|
5179
|
+
description: step.description,
|
|
5180
|
+
next: serializeNext(step.next)
|
|
5181
|
+
})),
|
|
5182
|
+
entryPoint: w.entryPoint
|
|
5126
5183
|
})),
|
|
5127
5184
|
agents: (org.agents ?? []).map((a) => ({
|
|
5128
5185
|
resourceId: a.config.resourceId,
|
package/package.json
CHANGED
|
@@ -1,11 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@elevasis/sdk",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.12",
|
|
4
4
|
"description": "SDK for building Elevasis organization resources",
|
|
5
|
-
"comment:bin": "IMPORTANT: This package shares the 'elevasis' binary name with @repo/cli. They never conflict because @elevasis/sdk must NEVER be added as a dependency of any workspace package (apps/*, packages/*, organizations/*). Workspace projects use @repo/cli for the 'elevasis' binary. External developers (outside the workspace) get this SDK's binary via npm install.",
|
|
6
5
|
"type": "module",
|
|
7
6
|
"bin": {
|
|
8
|
-
"elevasis": "./dist/cli.cjs",
|
|
9
7
|
"elevasis-sdk": "./dist/cli.cjs"
|
|
10
8
|
},
|
|
11
9
|
"exports": {
|
package/reference/_navigation.md
CHANGED
|
@@ -14,7 +14,7 @@ All paths are relative to `node_modules/@elevasis/sdk/reference/`.
|
|
|
14
14
|
|
|
15
15
|
| Resource | Location | Description | When to Load |
|
|
16
16
|
| --- | --- | --- | --- |
|
|
17
|
-
| CLI Reference | `cli/index.mdx` | Full reference for every elevasis CLI command -- scaffold, validate, deploy, execute, and inspect resources | Running CLI operations |
|
|
17
|
+
| CLI Reference | `cli/index.mdx` | Full reference for every elevasis-sdk CLI command -- scaffold, validate, deploy, execute, and inspect resources | Running CLI operations |
|
|
18
18
|
|
|
19
19
|
## Concepts
|
|
20
20
|
|
|
@@ -29,7 +29,7 @@ All paths are relative to `node_modules/@elevasis/sdk/reference/`.
|
|
|
29
29
|
| Execution API | `deployment/api.mdx` | REST endpoints for executing resources, querying execution history, and managing deployments via the Elevasis external API | Calling the API directly or debugging API responses |
|
|
30
30
|
| Command Center UI | `deployment/command-center-ui.mdx` | Reference for the Elevasis Command Center -- what each page does, when to use it post-deployment, and how SDK concepts map to UI actions | User asks about the Command Center UI, post-deployment workflow, or monitoring deployed resources |
|
|
31
31
|
| Command View | `deployment/command-view.mdx` | How the Command View graph works -- node types, relationships, what is enforced vs decorative, and what the platform needs to render your resource graph | Deploying resources or building resources that invoke other resources |
|
|
32
|
-
| Deploying Resources | `deployment/index.mdx` | How to deploy your Elevasis SDK resources to the platform using elevasis deploy, including configuration, validation, and environment setup | Preparing to deploy or debugging deploy failures |
|
|
32
|
+
| Deploying Resources | `deployment/index.mdx` | How to deploy your Elevasis SDK resources to the platform using elevasis-sdk deploy, including configuration, validation, and environment setup | Preparing to deploy or debugging deploy failures |
|
|
33
33
|
|
|
34
34
|
## Developer
|
|
35
35
|
|
|
@@ -45,7 +45,7 @@ All paths are relative to `node_modules/@elevasis/sdk/reference/`.
|
|
|
45
45
|
| Resource Documentation | `framework/documentation.mdx` | Write and deploy MDX documentation alongside your Elevasis resources | Writing or updating project documentation |
|
|
46
46
|
| Development Framework | `framework/index.mdx` | The SDK scaffolds a complete development environment for Claude Code -- project instructions, slash commands, cross-session memory, and template versioning | Understanding the agent framework structure |
|
|
47
47
|
| Memory System | `framework/memory.mdx` | Cross-session project knowledge stored in .claude/memory/ -- deployment state, environment, decisions, and error patterns that persist between Claude Code sessions | Working with agent memory or session state |
|
|
48
|
-
| Project Structure | `framework/project-structure.mdx` | Each file scaffolded by elevasis init and its purpose in the development workflow | Understanding scaffolded files or project layout |
|
|
48
|
+
| Project Structure | `framework/project-structure.mdx` | Each file scaffolded by elevasis-sdk init and its purpose in the development workflow | Understanding scaffolded files or project layout |
|
|
49
49
|
|
|
50
50
|
## Getting-started
|
|
51
51
|
|
package/reference/cli/index.mdx
CHANGED
|
@@ -1,29 +1,29 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: CLI Reference
|
|
3
|
-
description: Full reference for every elevasis CLI command -- scaffold, validate, deploy, execute, and inspect resources
|
|
3
|
+
description: Full reference for every elevasis-sdk CLI command -- scaffold, validate, deploy, execute, and inspect resources
|
|
4
4
|
loadWhen: "Running CLI operations"
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
The `elevasis` 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.
|
|
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
8
|
|
|
9
9
|
**Installation:**
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
|
-
|
|
12
|
+
pnpm add @elevasis/sdk
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
After installation, the `elevasis` binary is available in your project's `node_modules/.bin/`. Most commands require `ELEVASIS_API_KEY` to be set in your environment or a `.env` file.
|
|
15
|
+
After installation, the `elevasis-sdk` binary is available in your project's `node_modules/.bin/`. Most commands require `ELEVASIS_API_KEY` to be set in your environment or a `.env` file.
|
|
16
16
|
|
|
17
17
|
---
|
|
18
18
|
|
|
19
|
-
## elevasis init
|
|
19
|
+
## elevasis-sdk init
|
|
20
20
|
|
|
21
21
|
Scaffold a new Elevasis SDK project in the specified directory.
|
|
22
22
|
|
|
23
23
|
**Synopsis:**
|
|
24
24
|
|
|
25
25
|
```
|
|
26
|
-
elevasis init [directory]
|
|
26
|
+
elevasis-sdk init [directory]
|
|
27
27
|
```
|
|
28
28
|
|
|
29
29
|
**Behavior:**
|
|
@@ -42,7 +42,13 @@ elevasis init [directory]
|
|
|
42
42
|
**Example:**
|
|
43
43
|
|
|
44
44
|
```bash
|
|
45
|
-
elevasis init my-project
|
|
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
|
|
46
52
|
```
|
|
47
53
|
|
|
48
54
|
```
|
|
@@ -52,20 +58,20 @@ elevasis init my-project
|
|
|
52
58
|
|
|
53
59
|
Next steps:
|
|
54
60
|
cd my-project
|
|
55
|
-
|
|
56
|
-
elevasis check
|
|
61
|
+
pnpm install
|
|
62
|
+
elevasis-sdk check
|
|
57
63
|
```
|
|
58
64
|
|
|
59
65
|
---
|
|
60
66
|
|
|
61
|
-
## elevasis check
|
|
67
|
+
## elevasis-sdk check
|
|
62
68
|
|
|
63
69
|
Validate all resource definitions in your project without deploying.
|
|
64
70
|
|
|
65
71
|
**Synopsis:**
|
|
66
72
|
|
|
67
73
|
```
|
|
68
|
-
elevasis check
|
|
74
|
+
elevasis-sdk check
|
|
69
75
|
```
|
|
70
76
|
|
|
71
77
|
**Behavior:**
|
|
@@ -88,7 +94,7 @@ elevasis check
|
|
|
88
94
|
**Example output (success):**
|
|
89
95
|
|
|
90
96
|
```
|
|
91
|
-
$ elevasis check
|
|
97
|
+
$ elevasis-sdk check
|
|
92
98
|
|
|
93
99
|
Validating... done (4 resources, 0 errors)
|
|
94
100
|
```
|
|
@@ -96,7 +102,7 @@ $ elevasis check
|
|
|
96
102
|
**Example output (failure):**
|
|
97
103
|
|
|
98
104
|
```
|
|
99
|
-
$ elevasis check
|
|
105
|
+
$ elevasis-sdk check
|
|
100
106
|
|
|
101
107
|
Validating...
|
|
102
108
|
ERROR Duplicate resource ID 'onboard-client' in organization 'Acme Corp'
|
|
@@ -107,20 +113,20 @@ $ elevasis check
|
|
|
107
113
|
|
|
108
114
|
---
|
|
109
115
|
|
|
110
|
-
## elevasis deploy
|
|
116
|
+
## elevasis-sdk deploy
|
|
111
117
|
|
|
112
118
|
Bundle your project with esbuild and deploy it to the Elevasis platform.
|
|
113
119
|
|
|
114
120
|
**Synopsis:**
|
|
115
121
|
|
|
116
122
|
```
|
|
117
|
-
elevasis deploy
|
|
123
|
+
elevasis-sdk deploy
|
|
118
124
|
```
|
|
119
125
|
|
|
120
126
|
**Behavior:**
|
|
121
127
|
|
|
122
128
|
- Authenticates with `ELEVASIS_API_KEY` and resolves your organization name
|
|
123
|
-
- Runs the same `ResourceRegistry` validation as `elevasis check`
|
|
129
|
+
- Runs the same `ResourceRegistry` validation as `elevasis-sdk check`
|
|
124
130
|
- Bundles your `src/index.ts` and all dependencies into a single self-contained JS file (`dist/bundle.js`, approximately 50-200 KB)
|
|
125
131
|
- Uploads the bundle plus resource metadata to `POST /api/external/deploy`
|
|
126
132
|
- Streams deploy status and prints the result
|
|
@@ -143,7 +149,7 @@ elevasis deploy
|
|
|
143
149
|
**Example output (success):**
|
|
144
150
|
|
|
145
151
|
```
|
|
146
|
-
$ elevasis deploy
|
|
152
|
+
$ elevasis-sdk deploy
|
|
147
153
|
|
|
148
154
|
Authenticating... done (acme-corp)
|
|
149
155
|
Validating... done (4 resources, 0 errors)
|
|
@@ -157,7 +163,7 @@ $ elevasis deploy
|
|
|
157
163
|
**Example output (validation failure):**
|
|
158
164
|
|
|
159
165
|
```
|
|
160
|
-
$ elevasis deploy
|
|
166
|
+
$ elevasis-sdk deploy
|
|
161
167
|
|
|
162
168
|
Authenticating... done (acme-corp)
|
|
163
169
|
Validating...
|
|
@@ -169,14 +175,14 @@ $ elevasis deploy
|
|
|
169
175
|
|
|
170
176
|
---
|
|
171
177
|
|
|
172
|
-
## elevasis exec
|
|
178
|
+
## elevasis-sdk exec
|
|
173
179
|
|
|
174
180
|
Execute a deployed resource by ID.
|
|
175
181
|
|
|
176
182
|
**Synopsis:**
|
|
177
183
|
|
|
178
184
|
```
|
|
179
|
-
elevasis exec <resource> --input '{...}'
|
|
185
|
+
elevasis-sdk exec <resource> --input '{...}'
|
|
180
186
|
```
|
|
181
187
|
|
|
182
188
|
**Behavior:**
|
|
@@ -198,7 +204,7 @@ elevasis exec <resource> --input '{...}'
|
|
|
198
204
|
**Example:**
|
|
199
205
|
|
|
200
206
|
```bash
|
|
201
|
-
elevasis exec onboard-client --input '{"clientName": "Jane", "email": "jane@example.com"}'
|
|
207
|
+
elevasis-sdk exec onboard-client --input '{"clientName": "Jane", "email": "jane@example.com"}'
|
|
202
208
|
```
|
|
203
209
|
|
|
204
210
|
```
|
|
@@ -218,24 +224,24 @@ elevasis exec onboard-client --input '{"clientName": "Jane", "email": "jane@exam
|
|
|
218
224
|
**Async example:**
|
|
219
225
|
|
|
220
226
|
```bash
|
|
221
|
-
elevasis exec onboard-client --input '{"clientName": "Jane"}' --async
|
|
227
|
+
elevasis-sdk exec onboard-client --input '{"clientName": "Jane"}' --async
|
|
222
228
|
```
|
|
223
229
|
|
|
224
230
|
```
|
|
225
231
|
Execution started: exec_550e8400
|
|
226
|
-
Poll with: elevasis execution onboard-client exec_550e8400
|
|
232
|
+
Poll with: elevasis-sdk execution onboard-client exec_550e8400
|
|
227
233
|
```
|
|
228
234
|
|
|
229
235
|
---
|
|
230
236
|
|
|
231
|
-
## elevasis resources
|
|
237
|
+
## elevasis-sdk resources
|
|
232
238
|
|
|
233
239
|
List all deployed resources for your organization.
|
|
234
240
|
|
|
235
241
|
**Synopsis:**
|
|
236
242
|
|
|
237
243
|
```
|
|
238
|
-
elevasis resources
|
|
244
|
+
elevasis-sdk resources
|
|
239
245
|
```
|
|
240
246
|
|
|
241
247
|
**Behavior:**
|
|
@@ -254,7 +260,7 @@ elevasis resources
|
|
|
254
260
|
**Example output:**
|
|
255
261
|
|
|
256
262
|
```
|
|
257
|
-
$ elevasis resources
|
|
263
|
+
$ elevasis-sdk resources
|
|
258
264
|
|
|
259
265
|
onboard-client workflow Onboard Client prod
|
|
260
266
|
send-report workflow Send Weekly Report prod
|
|
@@ -264,14 +270,14 @@ $ elevasis resources
|
|
|
264
270
|
|
|
265
271
|
---
|
|
266
272
|
|
|
267
|
-
## elevasis executions
|
|
273
|
+
## elevasis-sdk executions
|
|
268
274
|
|
|
269
275
|
View execution history for a resource.
|
|
270
276
|
|
|
271
277
|
**Synopsis:**
|
|
272
278
|
|
|
273
279
|
```
|
|
274
|
-
elevasis executions [resource]
|
|
280
|
+
elevasis-sdk executions [resource]
|
|
275
281
|
```
|
|
276
282
|
|
|
277
283
|
**Behavior:**
|
|
@@ -292,7 +298,7 @@ elevasis executions [resource]
|
|
|
292
298
|
**Example:**
|
|
293
299
|
|
|
294
300
|
```bash
|
|
295
|
-
elevasis executions onboard-client --limit 5
|
|
301
|
+
elevasis-sdk executions onboard-client --limit 5
|
|
296
302
|
```
|
|
297
303
|
|
|
298
304
|
```
|
|
@@ -305,14 +311,14 @@ elevasis executions onboard-client --limit 5
|
|
|
305
311
|
|
|
306
312
|
---
|
|
307
313
|
|
|
308
|
-
## elevasis execution
|
|
314
|
+
## elevasis-sdk execution
|
|
309
315
|
|
|
310
316
|
View full detail for a single execution.
|
|
311
317
|
|
|
312
318
|
**Synopsis:**
|
|
313
319
|
|
|
314
320
|
```
|
|
315
|
-
elevasis execution <resource> <id>
|
|
321
|
+
elevasis-sdk execution <resource> <id>
|
|
316
322
|
```
|
|
317
323
|
|
|
318
324
|
**Behavior:**
|
|
@@ -330,7 +336,7 @@ elevasis execution <resource> <id>
|
|
|
330
336
|
**Example:**
|
|
331
337
|
|
|
332
338
|
```bash
|
|
333
|
-
elevasis execution onboard-client exec_abc001
|
|
339
|
+
elevasis-sdk execution onboard-client exec_abc001
|
|
334
340
|
```
|
|
335
341
|
|
|
336
342
|
```
|
|
@@ -360,14 +366,14 @@ elevasis execution onboard-client exec_abc001
|
|
|
360
366
|
|
|
361
367
|
---
|
|
362
368
|
|
|
363
|
-
## elevasis deployments
|
|
369
|
+
## elevasis-sdk deployments
|
|
364
370
|
|
|
365
371
|
List all deployments for your organization.
|
|
366
372
|
|
|
367
373
|
**Synopsis:**
|
|
368
374
|
|
|
369
375
|
```
|
|
370
|
-
elevasis deployments
|
|
376
|
+
elevasis-sdk deployments
|
|
371
377
|
```
|
|
372
378
|
|
|
373
379
|
**Behavior:**
|
|
@@ -385,7 +391,7 @@ elevasis deployments
|
|
|
385
391
|
**Example output:**
|
|
386
392
|
|
|
387
393
|
```
|
|
388
|
-
$ elevasis deployments
|
|
394
|
+
$ elevasis-sdk deployments
|
|
389
395
|
|
|
390
396
|
deploy_abc123 active 2026-02-25 14:00:00 4 resources
|
|
391
397
|
deploy_abc122 stopped 2026-02-24 09:30:00 3 resources
|
|
@@ -394,14 +400,14 @@ $ elevasis deployments
|
|
|
394
400
|
|
|
395
401
|
---
|
|
396
402
|
|
|
397
|
-
## elevasis describe
|
|
403
|
+
## elevasis-sdk describe
|
|
398
404
|
|
|
399
405
|
Show the definition of a deployed resource.
|
|
400
406
|
|
|
401
407
|
**Synopsis:**
|
|
402
408
|
|
|
403
409
|
```
|
|
404
|
-
elevasis describe <resource>
|
|
410
|
+
elevasis-sdk describe <resource>
|
|
405
411
|
```
|
|
406
412
|
|
|
407
413
|
**Behavior:**
|
|
@@ -420,7 +426,7 @@ elevasis describe <resource>
|
|
|
420
426
|
**Example:**
|
|
421
427
|
|
|
422
428
|
```bash
|
|
423
|
-
elevasis describe onboard-client
|
|
429
|
+
elevasis-sdk describe onboard-client
|
|
424
430
|
```
|
|
425
431
|
|
|
426
432
|
```
|
|
@@ -444,16 +450,16 @@ elevasis describe onboard-client
|
|
|
444
450
|
|
|
445
451
|
---
|
|
446
452
|
|
|
447
|
-
## elevasis env
|
|
453
|
+
## elevasis-sdk env
|
|
448
454
|
|
|
449
455
|
Manage environment variables for your project.
|
|
450
456
|
|
|
451
457
|
**Synopsis:**
|
|
452
458
|
|
|
453
459
|
```
|
|
454
|
-
elevasis env list
|
|
455
|
-
elevasis env set <key> <value>
|
|
456
|
-
elevasis env remove <key>
|
|
460
|
+
elevasis-sdk env list
|
|
461
|
+
elevasis-sdk env set <key> <value>
|
|
462
|
+
elevasis-sdk env remove <key>
|
|
457
463
|
```
|
|
458
464
|
|
|
459
465
|
**Behavior:**
|
|
@@ -471,9 +477,9 @@ elevasis env remove <key>
|
|
|
471
477
|
**Examples:**
|
|
472
478
|
|
|
473
479
|
```bash
|
|
474
|
-
elevasis env list
|
|
475
|
-
elevasis env set OPENAI_API_KEY sk-proj-***
|
|
476
|
-
elevasis env remove OPENAI_API_KEY
|
|
480
|
+
elevasis-sdk env list
|
|
481
|
+
elevasis-sdk env set OPENAI_API_KEY sk-proj-***
|
|
482
|
+
elevasis-sdk env remove OPENAI_API_KEY
|
|
477
483
|
```
|
|
478
484
|
|
|
479
485
|
---
|
|
@@ -23,7 +23,7 @@ This page covers core Elevasis concepts in plain English. It is the teaching voc
|
|
|
23
23
|
| Handler | The function inside a step that does the actual work. It receives input data and returns output data. |
|
|
24
24
|
| Entry Point | The first step that runs when a workflow is executed. Every workflow must have one. |
|
|
25
25
|
| Resource ID | A unique lowercase name for your resource (e.g., `lead-scorer`, `send-welcome-email`). Must be unique within your organization. |
|
|
26
|
-
| Workspace | Your Elevasis project directory. Contains resources (workflows and agents), documentation, and optionally a database connection and custom apps. Created by `elevasis init`. |
|
|
26
|
+
| Workspace | Your Elevasis project directory. Contains resources (workflows and agents), documentation, and optionally a database connection and custom apps. Created by `elevasis-sdk init`. |
|
|
27
27
|
| Data Table | A table in your database (e.g., Supabase) that stores structured data your workflows can read and write. Defined in `data/schema.ts` as documentation for the agent. |
|
|
28
28
|
|
|
29
29
|
---
|
|
@@ -94,7 +94,7 @@ type MyInput = z.infer<typeof myInput>;
|
|
|
94
94
|
|
|
95
95
|
### What Happens When You Run a Workflow
|
|
96
96
|
|
|
97
|
-
1. A request arrives at the Elevasis platform (someone runs `elevasis exec` or a schedule triggers)
|
|
97
|
+
1. A request arrives at the Elevasis platform (someone runs `elevasis-sdk exec` or a schedule triggers)
|
|
98
98
|
2. The platform creates a temporary server just for this execution
|
|
99
99
|
3. Your code runs on that server
|
|
100
100
|
4. The result is sent back
|
|
@@ -245,7 +245,7 @@ Upload a resource bundle and deploy it. Accepts a multipart request with the com
|
|
|
245
245
|
}
|
|
246
246
|
```
|
|
247
247
|
|
|
248
|
-
Use `elevasis deploy` from the CLI rather than calling this endpoint directly -- the CLI handles bundling, metadata generation, and status streaming automatically.
|
|
248
|
+
Use `elevasis-sdk deploy` from the CLI rather than calling this endpoint directly -- the CLI handles bundling, metadata generation, and status streaming automatically.
|
|
249
249
|
|
|
250
250
|
### GET /api/external/deployments
|
|
251
251
|
|
|
@@ -284,13 +284,13 @@ The SDK CLI wraps all execution endpoints. Use these commands instead of calling
|
|
|
284
284
|
|
|
285
285
|
| Command | API call | Purpose |
|
|
286
286
|
| ------- | -------- | ------- |
|
|
287
|
-
| `elevasis resources` | `GET /api/external/resources` | List all resources |
|
|
288
|
-
| `elevasis describe <resource>` | `GET /api/external/resources/:id/definition` | Show resource definition |
|
|
289
|
-
| `elevasis exec <resource> --input '...'` | `POST /api/external/execute` | Execute synchronously |
|
|
290
|
-
| `elevasis exec <resource> --input '...' --async` | `POST /api/external/execute-async` | Execute asynchronously |
|
|
291
|
-
| `elevasis executions <resource>` | `GET /api/external/executions/:id` | List execution history |
|
|
292
|
-
| `elevasis execution <resource> <id>` | `GET /api/external/executions/:id/:execId` | Get execution detail |
|
|
293
|
-
| `elevasis deployments` | `GET /api/external/deployments` | List deployments |
|
|
287
|
+
| `elevasis-sdk resources` | `GET /api/external/resources` | List all resources |
|
|
288
|
+
| `elevasis-sdk describe <resource>` | `GET /api/external/resources/:id/definition` | Show resource definition |
|
|
289
|
+
| `elevasis-sdk exec <resource> --input '...'` | `POST /api/external/execute` | Execute synchronously |
|
|
290
|
+
| `elevasis-sdk exec <resource> --input '...' --async` | `POST /api/external/execute-async` | Execute asynchronously |
|
|
291
|
+
| `elevasis-sdk executions <resource>` | `GET /api/external/executions/:id` | List execution history |
|
|
292
|
+
| `elevasis-sdk execution <resource> <id>` | `GET /api/external/executions/:id/:execId` | Get execution detail |
|
|
293
|
+
| `elevasis-sdk deployments` | `GET /api/external/deployments` | List deployments |
|
|
294
294
|
|
|
295
295
|
---
|
|
296
296
|
|
|
@@ -4,7 +4,7 @@ description: Reference for the Elevasis Command Center -- what each page does, w
|
|
|
4
4
|
loadWhen: "User asks about the Command Center UI, post-deployment workflow, or monitoring deployed resources"
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
-
The Command Center is the browser UI for interacting with deployed resources. After you run `elevasis deploy`, this is where you run workflows, monitor executions, manage approvals, schedule tasks, and review logs. This reference covers each page and how it connects to your SDK code.
|
|
7
|
+
The Command Center is the browser UI for interacting with deployed resources. After you run `elevasis-sdk deploy`, this is where you run workflows, monitor executions, manage approvals, schedule tasks, and review logs. This reference covers each page and how it connects to your SDK code.
|
|
8
8
|
|
|
9
9
|
---
|
|
10
10
|
|
|
@@ -103,7 +103,7 @@ The Execution Logs page shows the history of all executions across every deploye
|
|
|
103
103
|
- Filter by `failed` status to triage production issues
|
|
104
104
|
- Use date range to narrow down incidents
|
|
105
105
|
|
|
106
|
-
> **SDK takeaway:** Every `elevasis exec` and every scheduled run appears here. Use this page to verify behavior after deploy and to diagnose failures before opening code.
|
|
106
|
+
> **SDK takeaway:** Every `elevasis-sdk exec` and every scheduled run appears here. Use this page to verify behavior after deploy and to diagnose failures before opening code.
|
|
107
107
|
|
|
108
108
|
---
|
|
109
109
|
|
|
@@ -142,9 +142,9 @@ The Deployments page shows the history of all deployments for your organization.
|
|
|
142
142
|
- Identify the currently active version
|
|
143
143
|
- Compare resource counts across deployments
|
|
144
144
|
|
|
145
|
-
**How it connects to your code:** Each `elevasis deploy` run creates a new deployment entry. The platform activates the new version atomically -- in-flight executions complete against the previous version while new executions start against the new one.
|
|
145
|
+
**How it connects to your code:** Each `elevasis-sdk deploy` run creates a new deployment entry. The platform activates the new version atomically -- in-flight executions complete against the previous version while new executions start against the new one.
|
|
146
146
|
|
|
147
|
-
> **SDK takeaway:** Check this page after `elevasis deploy` to confirm your resources are active. If something behaves unexpectedly, look here to confirm the latest version is live.
|
|
147
|
+
> **SDK takeaway:** Check this page after `elevasis-sdk deploy` to confirm your resources are active. If something behaves unexpectedly, look here to confirm the latest version is live.
|
|
148
148
|
|
|
149
149
|
---
|
|
150
150
|
|
|
@@ -16,8 +16,8 @@ Every resource you deploy becomes a node in the Command View. Some nodes are exe
|
|
|
16
16
|
|
|
17
17
|
| Type | What It Does | Deployed By |
|
|
18
18
|
| ---- | ------------ | ----------- |
|
|
19
|
-
| Workflow | Runs step handlers in sequence or branching paths | `elevasis deploy` |
|
|
20
|
-
| Agent | Autonomous LLM-powered resource with tools | `elevasis deploy` |
|
|
19
|
+
| Workflow | Runs step handlers in sequence or branching paths | `elevasis-sdk deploy` |
|
|
20
|
+
| Agent | Autonomous LLM-powered resource with tools | `elevasis-sdk deploy` |
|
|
21
21
|
|
|
22
22
|
### Visual-Only Nodes
|
|
23
23
|
|
|
@@ -108,7 +108,7 @@ This means the graph can drift from reality:
|
|
|
108
108
|
|
|
109
109
|
## Deploy-Time Validation
|
|
110
110
|
|
|
111
|
-
When you run `elevasis deploy` or `elevasis check`, the SDK validates your resource definitions locally using the same `ResourceRegistry` the platform uses.
|
|
111
|
+
When you run `elevasis-sdk deploy` or `elevasis-sdk check`, the SDK validates your resource definitions locally using the same `ResourceRegistry` the platform uses.
|
|
112
112
|
|
|
113
113
|
### What Gets Checked
|
|
114
114
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Deploying Resources
|
|
3
|
-
description: How to deploy your Elevasis SDK resources to the platform using elevasis deploy, including configuration, validation, and environment setup
|
|
3
|
+
description: How to deploy your Elevasis SDK resources to the platform using elevasis-sdk deploy, including configuration, validation, and environment setup
|
|
4
4
|
loadWhen: "Preparing to deploy or debugging deploy failures"
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -10,7 +10,7 @@ Deploying your resources makes them live on the Elevasis platform and immediatel
|
|
|
10
10
|
|
|
11
11
|
## How Deployment Works
|
|
12
12
|
|
|
13
|
-
When you run `elevasis deploy`, the CLI performs these steps in order:
|
|
13
|
+
When you run `elevasis-sdk deploy`, the CLI performs these steps in order:
|
|
14
14
|
|
|
15
15
|
1. **Authenticate** -- calls the API with your `ELEVASIS_API_KEY` to verify credentials and resolve your organization name
|
|
16
16
|
2. **Validate** -- runs your `src/index.ts` through `ResourceRegistry`, catching the same errors as the platform
|
|
@@ -25,7 +25,7 @@ There is no local dev server and no separate staging environment. Deployed resou
|
|
|
25
25
|
## Running a Deploy
|
|
26
26
|
|
|
27
27
|
```bash
|
|
28
|
-
elevasis deploy
|
|
28
|
+
elevasis-sdk deploy
|
|
29
29
|
```
|
|
30
30
|
|
|
31
31
|
**Successful deploy output:**
|
|
@@ -40,7 +40,7 @@ elevasis deploy
|
|
|
40
40
|
Deployment: deploy_abc123
|
|
41
41
|
```
|
|
42
42
|
|
|
43
|
-
Each deploy creates a new deployment record. The previous active deployment is automatically stopped. You can view all deployments with `elevasis deployments`.
|
|
43
|
+
Each deploy creates a new deployment record. The previous active deployment is automatically stopped. You can view all deployments with `elevasis-sdk deployments`.
|
|
44
44
|
|
|
45
45
|
---
|
|
46
46
|
|
|
@@ -67,7 +67,7 @@ The CLI validates your resources before bundling. Validation uses the same `Reso
|
|
|
67
67
|
2 errors. Deploy aborted.
|
|
68
68
|
```
|
|
69
69
|
|
|
70
|
-
Run `elevasis check` at any time to validate without deploying.
|
|
70
|
+
Run `elevasis-sdk check` at any time to validate without deploying.
|
|
71
71
|
|
|
72
72
|
---
|
|
73
73
|
|
|
@@ -113,7 +113,7 @@ Place `.env` in your project root. The CLI reads it automatically. Never commit
|
|
|
113
113
|
|
|
114
114
|
## Deployment Lifecycle
|
|
115
115
|
|
|
116
|
-
Each call to `elevasis deploy` creates a new deployment. The platform tracks all deployments for your organization.
|
|
116
|
+
Each call to `elevasis-sdk deploy` creates a new deployment. The platform tracks all deployments for your organization.
|
|
117
117
|
|
|
118
118
|
| Status | Meaning |
|
|
119
119
|
| ------ | ------- |
|
|
@@ -127,7 +127,7 @@ Only one deployment can be `active` at a time. Deploying again automatically mov
|
|
|
127
127
|
**View deployment history:**
|
|
128
128
|
|
|
129
129
|
```bash
|
|
130
|
-
elevasis deployments
|
|
130
|
+
elevasis-sdk deployments
|
|
131
131
|
```
|
|
132
132
|
|
|
133
133
|
```
|