@elevasis/sdk 0.5.10 → 0.5.11
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 +80 -78
- package/dist/index.d.ts +1 -1
- package/dist/templates.js +31 -30
- 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 +18 -18
- package/reference/getting-started/index.mdx +18 -29
- 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/templates.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
// package.json
|
|
2
2
|
|
|
3
3
|
// src/cli/commands/templates/core/workspace.ts
|
|
4
|
-
var TEMPLATE_VERSION =
|
|
4
|
+
var TEMPLATE_VERSION = 24;
|
|
5
5
|
function configTemplate() {
|
|
6
6
|
return `import type { ElevasConfig } from '@elevasis/sdk'
|
|
7
7
|
|
|
@@ -19,6 +19,7 @@ dist/
|
|
|
19
19
|
__elevasis_worker.ts
|
|
20
20
|
.claude/settings.local.json
|
|
21
21
|
.claude/memory/
|
|
22
|
+
package-lock.json
|
|
22
23
|
`;
|
|
23
24
|
if (ctx.hasUI) {
|
|
24
25
|
content += `ui/node_modules/
|
|
@@ -273,13 +274,13 @@ All \`reference/\` paths resolve to \`node_modules/@elevasis/sdk/reference/\`.
|
|
|
273
274
|
|
|
274
275
|
## Elevasis CLI
|
|
275
276
|
|
|
276
|
-
**MANDATORY:** Use the \`elevasis\` CLI for all execution/platform operations -- never \`npx\`, \`curl\`, or any other tool.
|
|
277
|
+
**MANDATORY:** Use the \`elevasis-sdk\` CLI for all execution/platform operations -- never \`npx\`, \`curl\`, or any other tool.
|
|
277
278
|
|
|
278
|
-
- \`elevasis exec <resource-id> --input '{...}'\` -- run a resource synchronously
|
|
279
|
-
- \`elevasis exec <resource-id> --input '{...}' --async\` -- run async, returns execution ID
|
|
280
|
-
- \`elevasis execution <resource-id> <execution-id>\` -- inspect execution detail
|
|
281
|
-
- \`elevasis check\` -- validate resource definitions without deploying
|
|
282
|
-
- \`elevasis deploy\` -- deploy to the platform
|
|
279
|
+
- \`elevasis-sdk exec <resource-id> --input '{...}'\` -- run a resource synchronously
|
|
280
|
+
- \`elevasis-sdk exec <resource-id> --input '{...}' --async\` -- run async, returns execution ID
|
|
281
|
+
- \`elevasis-sdk execution <resource-id> <execution-id>\` -- inspect execution detail
|
|
282
|
+
- \`elevasis-sdk check\` -- validate resource definitions without deploying
|
|
283
|
+
- \`elevasis-sdk deploy\` -- deploy to the platform
|
|
283
284
|
|
|
284
285
|
Organization is derived from your API key -- no org prefix needed in the resource ID.
|
|
285
286
|
For full CLI reference: \`reference/cli/index.mdx\`
|
|
@@ -490,7 +491,7 @@ When automation is none:
|
|
|
490
491
|
Skip the file tour. Start with what Elevasis does for their business -- use analogies
|
|
491
492
|
from \`reference/developer/interaction-guidance.mdx\` (recipe, assembly line, kitchen
|
|
492
493
|
appliance). Explain deployment plainly: "You write the recipe here, then deploy it so
|
|
493
|
-
it's live." Deploy the starter echo workflow (\`elevasis check\` + \`elevasis deploy\`),
|
|
494
|
+
it's live." Deploy the starter echo workflow (\`elevasis-sdk check\` + \`elevasis-sdk deploy\`),
|
|
494
495
|
THEN tour the Command Center so the user sees populated pages, not empty ones. Tour:
|
|
495
496
|
Command View (echo node), Execution Logs (result).
|
|
496
497
|
Observation focus: automation value understanding, Command Center comfort.
|
|
@@ -499,7 +500,7 @@ When automation is low-code or custom:
|
|
|
499
500
|
Tour project files: src/index.ts (registry), src/example/echo.ts (starter
|
|
500
501
|
workflow), src/operations/platform-status.ts (platform API example),
|
|
501
502
|
elevasis.config.ts, .env, docs/. Explain the execution model.
|
|
502
|
-
Verify: run \`elevasis resources\`. Then open the Command Center and tour the
|
|
503
|
+
Verify: run \`elevasis-sdk resources\`. Then open the Command Center and tour the
|
|
503
504
|
main pages: Command View (resource graph), Execution Logs.
|
|
504
505
|
Point out the echo workflow node in Command View.
|
|
505
506
|
Observation focus: cloud deployment model, UI navigation comfort.
|
|
@@ -509,14 +510,14 @@ Observation focus: cloud deployment model, UI navigation comfort.
|
|
|
509
510
|
When automation is none:
|
|
510
511
|
Frame the workflow as "a recipe." Use plain language: "settings" not "config",
|
|
511
512
|
"what data it needs" not "contract", "instructions" not "steps", "where it starts"
|
|
512
|
-
not "entryPoint." Agent writes all code changes. Agent runs \`elevasis exec\` to verify
|
|
513
|
+
not "entryPoint." Agent writes all code changes. Agent runs \`elevasis-sdk exec\` to verify
|
|
513
514
|
and narrates the result in plain terms.
|
|
514
515
|
Observation focus: recipe-to-result connection.
|
|
515
516
|
|
|
516
517
|
When automation is low-code or custom:
|
|
517
518
|
Modify the echo workflow. Walk through each part: config, contract, steps,
|
|
518
|
-
entryPoint. Deploy: \`elevasis check\` then \`elevasis deploy\`. Test with
|
|
519
|
-
\`elevasis exec echo --input '{"message":"hello"}'\`. Then open the Execution
|
|
519
|
+
entryPoint. Deploy: \`elevasis-sdk check\` then \`elevasis-sdk deploy\`. Test with
|
|
520
|
+
\`elevasis-sdk exec echo --input '{"message":"hello"}'\`. Then open the Execution
|
|
520
521
|
Runner in the Command Center, find the echo workflow, fill out the form, and
|
|
521
522
|
run it from the UI. Compare the result to the CLI output.
|
|
522
523
|
Observation focus: deployment-to-execution loop, TypeScript syntax comfort.
|
|
@@ -527,20 +528,20 @@ When automation is none:
|
|
|
527
528
|
Frame as "What information does your automation need?" Describe types in plain English:
|
|
528
529
|
text, number, yes/no, a choice from a list. NO Zod, no z.string(), no z.infer(), no
|
|
529
530
|
code shown. Agent reads identity.md goals and writes the workflow schema. Agent runs
|
|
530
|
-
\`elevasis exec\` with sample input and narrates the result.
|
|
531
|
+
\`elevasis-sdk exec\` with sample input and narrates the result.
|
|
531
532
|
Observation focus: data-to-input connection, required vs optional understanding.
|
|
532
533
|
|
|
533
534
|
When automation is low-code:
|
|
534
535
|
"Field mapping like Zapier, but with validation." Show Zod types briefly. Demonstrate
|
|
535
536
|
how \`.describe()\` documents each field. Build schema based on identity.md goals.
|
|
536
|
-
After deploy, run with \`elevasis exec --input '{...}'\` to verify each field.
|
|
537
|
+
After deploy, run with \`elevasis-sdk exec --input '{...}'\` to verify each field.
|
|
537
538
|
Observation focus: schema-to-input mapping, optional fields, types.
|
|
538
539
|
|
|
539
540
|
When automation is custom:
|
|
540
541
|
Explain schemas in plain English (concepts page). Show common Zod types.
|
|
541
542
|
Explain \`z.infer\`. Build a new workflow with real-world input schema based
|
|
542
543
|
on the user's goals (read .claude/memory/profile/identity.md). After deploy,
|
|
543
|
-
run with \`elevasis exec --input '{...}'\` to verify the schema and inspect
|
|
544
|
+
run with \`elevasis-sdk exec --input '{...}'\` to verify the schema and inspect
|
|
544
545
|
the execution output.
|
|
545
546
|
Observation focus: schema-to-input mapping, optional fields, types.
|
|
546
547
|
|
|
@@ -571,7 +572,7 @@ Observation focus: credential setup (CLI + UI), async/await.
|
|
|
571
572
|
When automation is none:
|
|
572
573
|
Frame as "Step 1 passes its result to Step 2, like a relay race." Command View is
|
|
573
574
|
PRIMARY teaching tool -- show the visual graph before explaining code. Agent builds
|
|
574
|
-
the 2-step workflow. Agent runs \`elevasis exec\` to verify and shows output flow.
|
|
575
|
+
the 2-step workflow. Agent runs \`elevasis-sdk exec\` to verify and shows output flow.
|
|
575
576
|
User opens Command View to see the two nodes + arrow. Code is secondary.
|
|
576
577
|
Observation focus: relay-race concept, visual graph comprehension.
|
|
577
578
|
|
|
@@ -587,7 +588,7 @@ Observation focus: data flow reasoning, relationship visualization.
|
|
|
587
588
|
When automation is none:
|
|
588
589
|
Frame as "If the customer is VIP, do this -- otherwise, do that." No StepType.CONDITIONAL
|
|
589
590
|
jargon -- focus on the concept, not the implementation. Agent adds the condition.
|
|
590
|
-
Agent runs \`elevasis exec\` for both paths. Open Execution Logs to see which
|
|
591
|
+
Agent runs \`elevasis-sdk exec\` for both paths. Open Execution Logs to see which
|
|
591
592
|
path ran. Guide log navigation step-by-step.
|
|
592
593
|
Observation focus: branching concept understanding, log navigation.
|
|
593
594
|
|
|
@@ -612,7 +613,7 @@ Change status from dev to production. Cover error handling: try/catch,
|
|
|
612
613
|
ExecutionError, PlatformToolError. Create a schedule in Task Scheduler (use
|
|
613
614
|
Recurring type for a cron schedule). If docs/ has pages, show Knowledge Base.
|
|
614
615
|
Open Deployments page to confirm the latest version is active. Show CLI
|
|
615
|
-
monitoring: elevasis executions, elevasis execution. Suggest next steps.
|
|
616
|
+
monitoring: elevasis-sdk executions, elevasis-sdk execution. Suggest next steps.
|
|
616
617
|
Observation focus: readiness for independent operation (CLI + UI).
|
|
617
618
|
|
|
618
619
|
## Module Menu
|
|
@@ -700,7 +701,7 @@ Read: \`reference/framework/agent.mdx\`.
|
|
|
700
701
|
Build: Create an agent definition with tools. Configure LLM tool calling.
|
|
701
702
|
Compare agent vs workflow for a task.
|
|
702
703
|
Key concepts: agent definition, tool registration, LLM tool calling, execution trace.
|
|
703
|
-
Verify: Run agent with \`elevasis exec\`, review tool call trace in Execution Logs.
|
|
704
|
+
Verify: Run agent with \`elevasis-sdk exec\`, review tool call trace in Execution Logs.
|
|
704
705
|
|
|
705
706
|
## Meta-Framework Track
|
|
706
707
|
|
|
@@ -823,7 +824,7 @@ Observation focus: customization concept, owned vs managed files.
|
|
|
823
824
|
|
|
824
825
|
When automation is low-code:
|
|
825
826
|
Show the \`.claude/rules/\` directory. Explain the two types: sdk-patterns.md (MANAGED --
|
|
826
|
-
updated by elevasis update) and workspace-patterns.md (INIT_ONLY -- yours to edit).
|
|
827
|
+
updated by elevasis-sdk update) and workspace-patterns.md (INIT_ONLY -- yours to edit).
|
|
827
828
|
Explain path-scoping briefly: "These rules only activate when the agent is working on
|
|
828
829
|
certain file types." Show an example rule with WRONG/RIGHT pattern. Explain error
|
|
829
830
|
promotion: if something goes wrong 3+ times, add it here.
|
|
@@ -853,7 +854,7 @@ Next steps: point to reference docs in docs/, encourage using /work for new task
|
|
|
853
854
|
Observation focus: update model concept, project map as navigation aid.
|
|
854
855
|
|
|
855
856
|
When automation is low-code:
|
|
856
|
-
Explain MANAGED (auto-updated by elevasis update) vs INIT_ONLY (set once, yours).
|
|
857
|
+
Explain MANAGED (auto-updated by elevasis-sdk update) vs INIT_ONLY (set once, yours).
|
|
857
858
|
Show how /meta fix applies SDK updates with conflict handling: "If a file changed,
|
|
858
859
|
it shows you both versions and lets you decide."
|
|
859
860
|
Show \`docs/project-map.mdx\` and explain what it contains: resources, commands,
|
|
@@ -877,7 +878,7 @@ Observation focus: full template lifecycle, conflict resolution pattern.
|
|
|
877
878
|
|
|
878
879
|
**automation: none**
|
|
879
880
|
Use the non-technical variant for each lesson. Agent writes all code -- user
|
|
880
|
-
never types code. Agent runs \`elevasis exec\` for verification and narrates results.
|
|
881
|
+
never types code. Agent runs \`elevasis-sdk exec\` for verification and narrates results.
|
|
881
882
|
Avoid all jargon; use analogies. CLI is the primary verification tool.
|
|
882
883
|
Always deploy before directing the user to the Command Center.
|
|
883
884
|
|
|
@@ -973,7 +974,7 @@ by the \`<!-- initialized: false -->\` flag in CLAUDE.md, or run manually.
|
|
|
973
974
|
\`\`\`
|
|
974
975
|
No other keys (no \`NODE_ENV\`, no extras). The \`.env\` file must contain
|
|
975
976
|
only \`ELEVASIS_PLATFORM_KEY\`.
|
|
976
|
-
Validate the key works: run \`elevasis resources\` (should return an empty
|
|
977
|
+
Validate the key works: run \`elevasis-sdk resources\` (should return an empty
|
|
977
978
|
list, not an auth error). If auth fails, tell the user their key appears
|
|
978
979
|
invalid and ask them to check it in the Elevasis dashboard.
|
|
979
980
|
|
|
@@ -1034,7 +1035,7 @@ by the \`<!-- initialized: false -->\` flag in CLAUDE.md, or run manually.
|
|
|
1034
1035
|
- If git remote exists: note remote URL in memory/profile/preferences.md
|
|
1035
1036
|
|
|
1036
1037
|
5. **Verify project**
|
|
1037
|
-
Run \`elevasis check\` to confirm the starter resource is valid.
|
|
1038
|
+
Run \`elevasis-sdk check\` to confirm the starter resource is valid.
|
|
1038
1039
|
Optionally deploy the echo workflow.
|
|
1039
1040
|
|
|
1040
1041
|
6. **Report**
|
|
@@ -1063,7 +1064,7 @@ Detect and repair all drift. Optionally upgrades the SDK first.
|
|
|
1063
1064
|
|
|
1064
1065
|
0. **SDK version check** -- Compare installed \`@elevasis/sdk\` against the latest
|
|
1065
1066
|
available. If behind, offer to run \`pnpm update @elevasis/sdk\` before
|
|
1066
|
-
continuing. If the user accepts, run it, then run \`elevasis update\` to add
|
|
1067
|
+
continuing. If the user accepts, run it, then run \`elevasis-sdk update\` to add
|
|
1067
1068
|
any new managed files and flag conflicts. For each flagged file:
|
|
1068
1069
|
- Read the current project file and the new template from \`@elevasis/sdk/templates\`
|
|
1069
1070
|
- Add new sections that don't exist; preserve user customizations
|
|
@@ -1092,7 +1093,7 @@ Detect and repair all drift. Optionally upgrades the SDK first.
|
|
|
1092
1093
|
suggest adding patterns. Surface suggestions only -- do not auto-generate.
|
|
1093
1094
|
8. **Project map freshness:** Check whether \`docs/project-map.mdx\` reflects the
|
|
1094
1095
|
current project state (resources, commands, rules, skills, memory files).
|
|
1095
|
-
Compare filesystem state against the map. If stale, run \`elevasis deploy\`
|
|
1096
|
+
Compare filesystem state against the map. If stale, run \`elevasis-sdk deploy\`
|
|
1096
1097
|
to regenerate, or patch inline for minor drift.
|
|
1097
1098
|
|
|
1098
1099
|
Each step reports its result. Steps 1-8 run even if step 0 is skipped.
|
|
@@ -1102,11 +1103,11 @@ Each step reports its result. Steps 1-8 run even if step 0 is skipped.
|
|
|
1102
1103
|
0. Read \`reference/deployment/command-view.mdx\` -- understand the Command View
|
|
1103
1104
|
model, relationship declarations, and what deploy-time validation checks.
|
|
1104
1105
|
This context is essential for diagnosing validation failures in steps 1-2.
|
|
1105
|
-
1. Run \`elevasis check\` (validation)
|
|
1106
|
+
1. Run \`elevasis-sdk check\` (validation)
|
|
1106
1107
|
2. Type check if \`tsconfig.json\` exists
|
|
1107
1108
|
3. Verify docs reflect current resources
|
|
1108
1109
|
4. If git configured: stage changes, commit with deploy message
|
|
1109
|
-
5. Run \`elevasis deploy\`
|
|
1110
|
+
5. Run \`elevasis-sdk deploy\`
|
|
1110
1111
|
6. \`docs/project-map.mdx\` is auto-regenerated by deploy (no manual bump needed)
|
|
1111
1112
|
7. Verify deployment via platform
|
|
1112
1113
|
8. Update \`memory/deployment-state.md\` with count, timestamp, inventory
|
|
@@ -1668,10 +1669,10 @@ description: Project map conventions -- auto-generated, do not edit, maintained
|
|
|
1668
1669
|
|
|
1669
1670
|
# Project Map
|
|
1670
1671
|
|
|
1671
|
-
- \`docs/project-map.mdx\` and \`docs/resource-map.mdx\` are fully auto-generated by \`elevasis deploy\`
|
|
1672
|
+
- \`docs/project-map.mdx\` and \`docs/resource-map.mdx\` are fully auto-generated by \`elevasis-sdk deploy\`
|
|
1672
1673
|
- Do not edit either file manually -- changes are overwritten on next deploy
|
|
1673
1674
|
- \`/meta fix\` step 8 checks for drift and patches the map
|
|
1674
|
-
- If a new command, rule, skill, or memory file is added, run \`/meta fix\` or \`elevasis deploy\` to update
|
|
1675
|
+
- If a new command, rule, skill, or memory file is added, run \`/meta fix\` or \`elevasis-sdk deploy\` to update
|
|
1675
1676
|
`;
|
|
1676
1677
|
}
|
|
1677
1678
|
function claudeTaskTrackingRuleTemplate() {
|
package/package.json
CHANGED
|
@@ -1,11 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@elevasis/sdk",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.11",
|
|
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
|
|