@elevasis/sdk 0.5.0 → 0.5.2
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 +1275 -250
- package/dist/index.d.ts +7 -4
- package/dist/templates.js +1109 -79
- package/dist/types/templates.d.ts +2 -1
- package/package.json +10 -10
- package/reference/_navigation.md +3 -2
- package/reference/deployment/command-center-ui.mdx +151 -0
- package/reference/developer/interaction-guidance.mdx +21 -52
- package/reference/framework/agent.mdx +11 -21
- package/reference/framework/index.mdx +4 -3
- package/reference/framework/project-structure.mdx +5 -13
- package/reference/runtime/limits.mdx +1 -3
|
@@ -1 +1,2 @@
|
|
|
1
|
-
export { claudeMdTemplate, claudeMetaCommandTemplate,
|
|
1
|
+
export { claudeMdTemplate, claudeMetaCommandTemplate, claudeWorkCommandTemplate, claudeTutorialCommandTemplate, claudeSettingsTemplate, claudeSdkBoundaryHookTemplate, claudeCredsSkillTemplate, claudeSdkPatternsRuleTemplate, claudeDocsAuthoringRuleTemplate, claudeMemoryConventionsRuleTemplate, claudeProjectMapRuleTemplate, claudeTaskTrackingRuleTemplate, gitignoreTemplate, starterWorkflowTemplate, platformStatusTemplate, operationsBarrelTemplate, exampleBarrelTemplate, } from './cli/commands/init.js';
|
|
2
|
+
export { getManagedTemplates } from './cli/commands/templates/core/index.js';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@elevasis/sdk",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.2",
|
|
4
4
|
"description": "SDK for building Elevasis organization resources",
|
|
5
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
6
|
"type": "module",
|
|
@@ -34,6 +34,11 @@
|
|
|
34
34
|
"dist/types/templates.d.ts",
|
|
35
35
|
"reference/"
|
|
36
36
|
],
|
|
37
|
+
"scripts": {
|
|
38
|
+
"build": "node -e \"require('fs').rmSync('dist',{recursive:true,force:true})\" && tsc -p tsconfig.core-dts.json && tsc -p tsconfig.build.json && tsup && rollup -c rollup.dts.config.mjs && esbuild src/cli/index.ts --bundle --platform=node --outfile=dist/cli.cjs --format=cjs --external:esbuild --external:jiti --banner:js=\"#!/usr/bin/env node\" && node scripts/copy-reference-docs.mjs && node scripts/generate-navigation.mjs",
|
|
39
|
+
"check-types": "tsc --noEmit",
|
|
40
|
+
"test:bundle": "pnpm build && vitest run --config vitest.bundle.config.ts"
|
|
41
|
+
},
|
|
37
42
|
"dependencies": {
|
|
38
43
|
"esbuild": "^0.25.0",
|
|
39
44
|
"jiti": "^2.0.0"
|
|
@@ -42,6 +47,8 @@
|
|
|
42
47
|
"zod": "^4.1.0"
|
|
43
48
|
},
|
|
44
49
|
"devDependencies": {
|
|
50
|
+
"@repo/core": "workspace:*",
|
|
51
|
+
"@repo/typescript-config": "workspace:*",
|
|
45
52
|
"@types/node": "^22.0.0",
|
|
46
53
|
"chalk": "^5.3.0",
|
|
47
54
|
"commander": "^11.0.0",
|
|
@@ -52,13 +59,6 @@
|
|
|
52
59
|
"rollup-plugin-dts": "^6.3.0",
|
|
53
60
|
"tsup": "^8.0.0",
|
|
54
61
|
"typescript": "5.9.2",
|
|
55
|
-
"zod": "^4.1.0"
|
|
56
|
-
"@repo/core": "0.0.0",
|
|
57
|
-
"@repo/typescript-config": "0.0.0"
|
|
58
|
-
},
|
|
59
|
-
"scripts": {
|
|
60
|
-
"build": "node -e \"require('fs').rmSync('dist',{recursive:true,force:true})\" && tsc -p tsconfig.core-dts.json && tsc -p tsconfig.build.json && tsup && rollup -c rollup.dts.config.mjs && esbuild src/cli/index.ts --bundle --platform=node --outfile=dist/cli.cjs --format=cjs --external:esbuild --external:jiti --banner:js=\"#!/usr/bin/env node\" && node scripts/copy-reference-docs.mjs && node scripts/generate-navigation.mjs",
|
|
61
|
-
"check-types": "tsc --noEmit",
|
|
62
|
-
"test:bundle": "pnpm build && vitest run --config vitest.bundle.config.ts"
|
|
62
|
+
"zod": "^4.1.0"
|
|
63
63
|
}
|
|
64
|
-
}
|
|
64
|
+
}
|
package/reference/_navigation.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# SDK Reference Navigation
|
|
2
2
|
|
|
3
|
-
Auto-generated from reference file frontmatter.
|
|
3
|
+
Auto-generated from reference file frontmatter. 32 files indexed.
|
|
4
4
|
|
|
5
5
|
All paths are relative to `node_modules/@elevasis/sdk/reference/`.
|
|
6
6
|
|
|
@@ -27,6 +27,7 @@ All paths are relative to `node_modules/@elevasis/sdk/reference/`.
|
|
|
27
27
|
| Resource | Location | Description | When to Load |
|
|
28
28
|
| --- | --- | --- | --- |
|
|
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
|
+
| 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 |
|
|
30
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 |
|
|
31
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
33
|
|
|
@@ -34,7 +35,7 @@ All paths are relative to `node_modules/@elevasis/sdk/reference/`.
|
|
|
34
35
|
|
|
35
36
|
| Resource | Location | Description | When to Load |
|
|
36
37
|
| --- | --- | --- | --- |
|
|
37
|
-
| Interaction Guidance | `developer/interaction-guidance.mdx` | Full dimensional adaptation rules per skill axis --
|
|
38
|
+
| Interaction Guidance | `developer/interaction-guidance.mdx` | Full dimensional adaptation rules per skill axis -- platform navigation, API integration, automation concepts, domain expertise -- with growth tracking protocol | Unsure how to adapt for a skill combination |
|
|
38
39
|
|
|
39
40
|
## Framework
|
|
40
41
|
|
|
@@ -0,0 +1,151 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: Command Center UI
|
|
3
|
+
description: Reference for the Elevasis Command Center -- what each page does, when to use it post-deployment, and how SDK concepts map to UI actions
|
|
4
|
+
loadWhen: "User asks about the Command Center UI, post-deployment workflow, or monitoring deployed resources"
|
|
5
|
+
---
|
|
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.
|
|
8
|
+
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
## Quick Reference
|
|
12
|
+
|
|
13
|
+
| Task | Page | Path |
|
|
14
|
+
| -------------------------------------------------- | -------------- | ----------------------- |
|
|
15
|
+
| Browse deployed resources, view the resource graph | Command View | `/command-view` |
|
|
16
|
+
| Approve or reject pending HITL requests | Command Queue | `/queue` |
|
|
17
|
+
| Browse deployed documentation | Knowledge Base | `/knowledge-base` |
|
|
18
|
+
| Search execution history across all resources | Execution Logs | `/logs` |
|
|
19
|
+
| Create API key and OAuth credentials | Credentials | `/settings/credentials` |
|
|
20
|
+
| View deployment history and active version | Deployments | `/settings/deployments` |
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Command View
|
|
25
|
+
|
|
26
|
+
The Command View is a visual graph of your deployed resources. Each node is a resource (workflow, agent, trigger, integration). Edges are the relationships you declared in `OrganizationResources`.
|
|
27
|
+
|
|
28
|
+
**What you can do here:**
|
|
29
|
+
|
|
30
|
+
- See all deployed resources at a glance
|
|
31
|
+
- Trace data flow between resources via declared relationships
|
|
32
|
+
- Identify which resources depend on which integrations
|
|
33
|
+
- Click a node to view resource details (ID, status, type)
|
|
34
|
+
|
|
35
|
+
**Graph accuracy:** The graph reflects your `relationships` declarations, not runtime behavior. If your handler calls another resource without a declared relationship, the edge is missing from the graph. Keep declarations in sync with your code.
|
|
36
|
+
|
|
37
|
+
For the full relationship model and what is enforced vs. decorative, see `reference/deployment/command-view.mdx`.
|
|
38
|
+
|
|
39
|
+
> **SDK takeaway:** Declare relationships in `OrganizationResources` to keep the Command View accurate as your system grows.
|
|
40
|
+
|
|
41
|
+
---
|
|
42
|
+
|
|
43
|
+
## Command Queue
|
|
44
|
+
|
|
45
|
+
The Command Queue surfaces all pending Human-in-the-Loop (HITL) approval requests from running workflows.
|
|
46
|
+
|
|
47
|
+
**What you can do here:**
|
|
48
|
+
|
|
49
|
+
- View pending approval requests with context provided by the workflow
|
|
50
|
+
- Filter by resource, status, or date
|
|
51
|
+
- Approve or reject with an optional comment
|
|
52
|
+
- See the history of past decisions
|
|
53
|
+
|
|
54
|
+
**How it connects to your code:** Approval requests appear here when a workflow step calls `approval.requestApproval()`. The workflow pauses at that step and waits for a decision before continuing.
|
|
55
|
+
|
|
56
|
+
```typescript
|
|
57
|
+
import { approval } from '@elevasis/sdk/worker'
|
|
58
|
+
|
|
59
|
+
const result = await approval.requestApproval({
|
|
60
|
+
title: 'Approve proposal before sending',
|
|
61
|
+
context: { dealId, proposalUrl },
|
|
62
|
+
})
|
|
63
|
+
|
|
64
|
+
if (result.approved) {
|
|
65
|
+
// continue
|
|
66
|
+
}
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
> **SDK takeaway:** Use `approval.requestApproval()` to create approval gates that surface here. Provide rich `context` so reviewers have what they need to decide.
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## Knowledge Base
|
|
74
|
+
|
|
75
|
+
The Knowledge Base renders the `docs/` directory of your deployed workspace as browsable documentation.
|
|
76
|
+
|
|
77
|
+
**What you can do here:**
|
|
78
|
+
|
|
79
|
+
- Browse pages you created in `docs/*.mdx`
|
|
80
|
+
- Search across all documentation
|
|
81
|
+
- Share links to specific pages with team members
|
|
82
|
+
|
|
83
|
+
**How it connects to your code:** Every `.mdx` file in your workspace's `docs/` directory is bundled at deploy time and rendered here. Pages appear in the order defined by their `order` frontmatter field.
|
|
84
|
+
|
|
85
|
+
> **SDK takeaway:** Write `docs/*.mdx` pages for your team -- business process docs, schema references, usage guides. They appear here automatically after each deploy.
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## Execution Logs
|
|
90
|
+
|
|
91
|
+
The Execution Logs page shows the history of all executions across every deployed resource.
|
|
92
|
+
|
|
93
|
+
**What you can do here:**
|
|
94
|
+
|
|
95
|
+
- Search and filter by resource, status (completed/failed/running), date range
|
|
96
|
+
- Click any execution to view full detail: input, output, step-level trace, duration
|
|
97
|
+
- Identify failed executions and see error messages with stack traces
|
|
98
|
+
- Navigate from a log entry directly to the resource in Command View
|
|
99
|
+
|
|
100
|
+
**Filtering tips:**
|
|
101
|
+
|
|
102
|
+
- Filter by resource name to debug a specific workflow
|
|
103
|
+
- Filter by `failed` status to triage production issues
|
|
104
|
+
- Use date range to narrow down incidents
|
|
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.
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
## Credentials
|
|
111
|
+
|
|
112
|
+
The Credentials page manages encrypted API keys and OAuth tokens used by your workflows at runtime.
|
|
113
|
+
|
|
114
|
+
**What you can do here:**
|
|
115
|
+
|
|
116
|
+
- Create API key and webhook-secret credentials via a form
|
|
117
|
+
- Connect OAuth providers (Notion, Google Sheets, Dropbox) via browser flow
|
|
118
|
+
- View existing credentials (values are never shown after creation)
|
|
119
|
+
- Delete credentials that are no longer needed
|
|
120
|
+
|
|
121
|
+
**Two credential types:**
|
|
122
|
+
|
|
123
|
+
| Type | Created via | Notes |
|
|
124
|
+
| ------------------------ | -------------------------------------------- | ------------------------------------------------------ |
|
|
125
|
+
| API key / webhook secret | CLI (`elevasis-sdk creds create`) or UI form | Either method works |
|
|
126
|
+
| OAuth | UI only | Requires browser redirect -- cannot be created via CLI |
|
|
127
|
+
|
|
128
|
+
**OAuth credentials require the UI.** When a workflow uses an OAuth-connected service, the user must complete the OAuth flow here first. The CLI `creds` skill handles API keys; redirect OAuth credential setup to this page.
|
|
129
|
+
|
|
130
|
+
> **SDK takeaway:** Reference credentials in your code by name (`credential: 'my-cred-name'`). Create API keys via CLI or UI; OAuth credentials require this page.
|
|
131
|
+
|
|
132
|
+
---
|
|
133
|
+
|
|
134
|
+
## Deployments
|
|
135
|
+
|
|
136
|
+
The Deployments page shows the history of all deployments for your organization.
|
|
137
|
+
|
|
138
|
+
**What you can do here:**
|
|
139
|
+
|
|
140
|
+
- View a chronological list of past deployments
|
|
141
|
+
- See which resources changed in each deployment
|
|
142
|
+
- Identify the currently active version
|
|
143
|
+
- Compare resource counts across deployments
|
|
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.
|
|
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.
|
|
148
|
+
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
**Last Updated:** 2026-03-03
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Interaction Guidance"
|
|
3
|
-
description: "Full dimensional adaptation rules per skill axis --
|
|
3
|
+
description: "Full dimensional adaptation rules per skill axis -- platform navigation, API integration, automation concepts, domain expertise -- with growth tracking protocol"
|
|
4
4
|
loadWhen: "Unsure how to adapt for a skill combination"
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -10,61 +10,28 @@ This reference defines how to adapt every interaction based on the dimensions in
|
|
|
10
10
|
|
|
11
11
|
## Skill Dimensions
|
|
12
12
|
|
|
13
|
-
The user profile stores
|
|
13
|
+
The user profile stores four independent skill dimensions. Each dimension has its own adaptation rules. Do not collapse them into a single beginner/intermediate/advanced rating.
|
|
14
14
|
|
|
15
|
-
###
|
|
15
|
+
### Platform Navigation (none / oriented / comfortable)
|
|
16
16
|
|
|
17
|
-
**none** --
|
|
17
|
+
**none** -- Never used the Command Center. Does not know where pages are.
|
|
18
18
|
|
|
19
|
-
-
|
|
20
|
-
-
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
- Walk through each line in plain English before showing code
|
|
24
|
-
- Do not assume they can read code independently
|
|
19
|
+
- Walk through each page step by step before directing the user there
|
|
20
|
+
- Provide exact navigation paths (e.g., "Open the Command Center, then click Execution Runner in the left sidebar")
|
|
21
|
+
- Explain what each page does before asking them to use it
|
|
22
|
+
- Do not assume they can find a page by name alone
|
|
25
23
|
|
|
26
|
-
**
|
|
24
|
+
**oriented** -- Has explored the Command Center, knows the main sections.
|
|
27
25
|
|
|
28
|
-
-
|
|
29
|
-
-
|
|
30
|
-
-
|
|
31
|
-
- Skip explanations of basic web/formula concepts they likely know
|
|
26
|
+
- Reference pages by name (Execution Runner, Command Queue, Task Scheduler)
|
|
27
|
+
- Briefly remind the user what a page does on first mention in a session
|
|
28
|
+
- Trust them to navigate once you name the destination
|
|
32
29
|
|
|
33
|
-
**comfortable** --
|
|
30
|
+
**comfortable** -- Regularly uses the Command Center without guidance.
|
|
34
31
|
|
|
35
|
-
-
|
|
36
|
-
-
|
|
37
|
-
-
|
|
38
|
-
|
|
39
|
-
**advanced** -- Writes production software professionally.
|
|
40
|
-
|
|
41
|
-
- Concise code, no commentary on language features
|
|
42
|
-
- Focus only on SDK-specific patterns and constraints
|
|
43
|
-
- Trust them to infer context from types and naming
|
|
44
|
-
|
|
45
|
-
---
|
|
46
|
-
|
|
47
|
-
### TypeScript (none / exposure / proficient)
|
|
48
|
-
|
|
49
|
-
**none** -- Has not used TypeScript or any statically typed language.
|
|
50
|
-
|
|
51
|
-
- Show complete files with every import
|
|
52
|
-
- Explain type annotations as "labels that describe what kind of data this is"
|
|
53
|
-
- Never use generics without a plain-English explanation
|
|
54
|
-
- Explain `z.infer` every time it appears: "This creates a TypeScript type from the schema so you get autocomplete and error checking"
|
|
55
|
-
- Explain the difference between runtime validation (Zod) and compile-time checking (TypeScript)
|
|
56
|
-
|
|
57
|
-
**exposure** -- Has read TypeScript or used a typed language (Java, C#, Go).
|
|
58
|
-
|
|
59
|
-
- Show code with brief type annotation comments for SDK-specific types
|
|
60
|
-
- Explain `WorkflowDefinition`, `StepType`, and `OrganizationResources` on first use
|
|
61
|
-
- Trust them to understand basic type syntax
|
|
62
|
-
|
|
63
|
-
**proficient** -- Has written TypeScript projects.
|
|
64
|
-
|
|
65
|
-
- Types without explanation
|
|
66
|
-
- Focus on SDK API surface, not language features
|
|
67
|
-
- Trust them to read type definitions
|
|
32
|
+
- Reference pages by name only, no reminders needed
|
|
33
|
+
- Focus on advanced filtering, schedule types, and log detail navigation
|
|
34
|
+
- Trust them to explore and navigate independently
|
|
68
35
|
|
|
69
36
|
---
|
|
70
37
|
|
|
@@ -163,9 +130,11 @@ Choose the analogy that fits the user's domain. A sales operations person will r
|
|
|
163
130
|
During each session, note behaviors that reveal skill level changes. Examples:
|
|
164
131
|
|
|
165
132
|
- User wrote a handler without asking for help
|
|
166
|
-
- User independently caught a type error before you pointed it out
|
|
167
133
|
- User suggested using StepType.CONDITIONAL without prompting
|
|
168
134
|
- User asked a question that shows they now understand the execution model
|
|
135
|
+
- User navigated to the correct Command Center page without being directed
|
|
136
|
+
- User filtered Execution Logs by resource independently to diagnose a failure
|
|
137
|
+
- User created a Task Scheduler entry unassisted
|
|
169
138
|
|
|
170
139
|
### Promotion Rules
|
|
171
140
|
|
|
@@ -181,7 +150,7 @@ When updating `.claude/memory/profile/skills.md` Growth Log:
|
|
|
181
150
|
|
|
182
151
|
```
|
|
183
152
|
| Date | Observation | Skill Updated |
|
|
184
|
-
| 2026-03-01 |
|
|
153
|
+
| 2026-03-01 | Navigated to Execution Logs and filtered by resource without direction | Platform Navigation: none -> oriented |
|
|
185
154
|
```
|
|
186
155
|
|
|
187
156
|
Also update the dimension's Level field and Evidence field to reflect the new assessment.
|
|
@@ -190,7 +159,7 @@ Also update the dimension's Level field and Evidence field to reflect the new as
|
|
|
190
159
|
|
|
191
160
|
When growth is observed, acknowledge it briefly:
|
|
192
161
|
|
|
193
|
-
- "You
|
|
162
|
+
- "You found that on your own -- looks like you've got the Command Center navigation down."
|
|
194
163
|
- "Good catch on the optional field -- that is exactly the kind of thing that trips people up."
|
|
195
164
|
|
|
196
165
|
Keep it natural. One sentence is enough. Do not over-celebrate.
|
|
@@ -42,14 +42,13 @@ At the start of every session the agent runs these steps silently before respond
|
|
|
42
42
|
|
|
43
43
|
Slash commands are short Markdown instruction files in `.claude/commands/`. When you type `/command-name` in a Claude Code session, the agent reads the corresponding file and follows its instructions.
|
|
44
44
|
|
|
45
|
-
|
|
45
|
+
Three commands and one skill are scaffolded by `elevasis init` and committed to version control so collaborators get the same experience:
|
|
46
46
|
|
|
47
47
|
| Command | File | Purpose |
|
|
48
48
|
| --- | --- | --- |
|
|
49
|
-
| `/meta` | `meta.md` | Project lifecycle -- init, status, fix, deploy, health |
|
|
50
|
-
| `/
|
|
51
|
-
| `/
|
|
52
|
-
| `/tutorial` | `tutorial.md` | Progressive 7-lesson learning path |
|
|
49
|
+
| `/meta` | `meta.md` | Project lifecycle -- init, status, fix (incl. docs verification), deploy, health |
|
|
50
|
+
| `/work` | `work.md` | Task tracking -- list, create, save, resume, complete |
|
|
51
|
+
| `/tutorial` | `tutorial.md` | Progressive learning path -- 3 tracks, menu-driven |
|
|
53
52
|
|
|
54
53
|
The `/creds` skill (`.claude/skills/creds/SKILL.md`) is also scaffolded. It auto-triggers when the agent detects credential-related context and manages credential storage and retrieval.
|
|
55
54
|
|
|
@@ -63,28 +62,19 @@ The `/meta` command namespace manages the full project lifecycle. It has five op
|
|
|
63
62
|
- **`/meta deploy`** -- Full 9-step deploy pipeline: validate, type-check, verify docs, commit, deploy (auto-regenerates `docs/project-map.mdx`), verify platform, update deployment state, and optionally push.
|
|
64
63
|
- **`/meta health`** -- Execution debugging and resource status; shows recent executions, analyzes failures, and checks environment connectivity.
|
|
65
64
|
|
|
66
|
-
### `/docs` Command
|
|
67
|
-
|
|
68
|
-
The `/docs` command manages documentation in `docs/`. It has four operations:
|
|
69
|
-
|
|
70
|
-
- **`/docs`** (no arguments) -- Review existing `docs/` files and suggest improvements. Identifies undocumented resources, missing descriptions, and structural gaps.
|
|
71
|
-
- **`/docs create <page-name>`** -- Scaffold a new documentation page with correct frontmatter, populated from resource definitions in `src/`.
|
|
72
|
-
- **`/docs review`** -- Review all `docs/` files for accuracy against actual resource definitions. Flags mismatches between documented schemas and code.
|
|
73
|
-
- **`/docs verify [path]`** -- Cross-reference documentation with the codebase. Reads the specified doc (or all docs if no path provided) and reports discrepancies against actual resource IDs, schema fields, and platform tools.
|
|
74
|
-
|
|
75
65
|
### `/work` Command
|
|
76
66
|
|
|
77
|
-
The `/work` command manages in-progress task tracking across sessions. It uses `docs/in-progress/` for task documents with standardized frontmatter (`status: planned | in-progress |
|
|
67
|
+
The `/work` command manages in-progress task tracking across sessions. It uses `docs/in-progress/` for task documents with standardized frontmatter (`status: planned | in-progress | complete`). Operations:
|
|
78
68
|
|
|
79
|
-
- **`/work`** (no arguments) --
|
|
80
|
-
- **`/work create
|
|
81
|
-
- **`/work save`** --
|
|
82
|
-
- **`/work resume [<name>]`** -- Load a task
|
|
83
|
-
- **`/work complete`** --
|
|
69
|
+
- **`/work`** (no arguments) -- Numbered list sorted by status (`in-progress` first) with last-saved date and current step. Pick by number to auto-resume.
|
|
70
|
+
- **`/work create`** -- Guided interview (3-4 questions) to create a task document with intelligent placement in `docs/in-progress/`.
|
|
71
|
+
- **`/work save`** -- Comprehensive snapshot: progress markers, files modified table, key docs to read on resume, and a "To continue" prompt. Proactively suggested before context pressure builds.
|
|
72
|
+
- **`/work resume [<name>]`** -- Load a task by number, keyword, or auto-detect. No file paths required.
|
|
73
|
+
- **`/work complete`** -- Seven-step pipeline: validate readiness, clean doc, determine destination in `docs/`, confirm with user, move, verify.
|
|
84
74
|
|
|
85
75
|
### `/tutorial` Command
|
|
86
76
|
|
|
87
|
-
The `/tutorial` command runs a
|
|
77
|
+
The `/tutorial` command shows a track menu on every invocation and runs a progressive learning path adapted to the user's skill profile. Three tracks: Orchestration Concepts (7 lessons), Examples & Advanced Modules (9 standalone modules), and Meta-Framework (5 lessons). Two skill dimensions tracked: `automation` (none / low-code / custom) and `platformNavigation` (none / oriented / comfortable).
|
|
88
78
|
|
|
89
79
|
## Developer Profile
|
|
90
80
|
|
|
@@ -16,10 +16,11 @@ Running `elevasis init my-project` produces the following agent infrastructure a
|
|
|
16
16
|
.claude/
|
|
17
17
|
├── settings.json # autoCompact: false
|
|
18
18
|
├── commands/
|
|
19
|
-
│ ├── docs.md # Documentation lifecycle
|
|
20
19
|
│ ├── meta.md # Project lifecycle (init, fix, deploy, health)
|
|
21
|
-
│ ├── tutorial.md # Progressive
|
|
20
|
+
│ ├── tutorial.md # Progressive learning path (3 tracks)
|
|
22
21
|
│ └── work.md # Task tracking
|
|
22
|
+
├── hooks/
|
|
23
|
+
│ └── enforce-sdk-boundary.mjs # Blocks destructive git, gh CLI, external writes
|
|
23
24
|
├── skills/
|
|
24
25
|
│ └── creds/SKILL.md # Credential management (auto-triggers)
|
|
25
26
|
└── rules/
|
|
@@ -51,7 +52,7 @@ The agent reads `memory/index.md` at session start and drills into `memory/profi
|
|
|
51
52
|
|
|
52
53
|
The `CLAUDE.md` file drives all agent behavior. It contains the session initialization instructions, adaptive guidance tiers, memory maintenance rules, and slash command definitions. No hooks, no code enforcement -- everything is instruction-driven so non-technical users never need to configure anything.
|
|
53
54
|
|
|
54
|
-
The `/meta` command manages the project lifecycle: `/meta init` for guided setup, `/meta fix` for SDK upgrades
|
|
55
|
+
The `/meta` command manages the project lifecycle: `/meta init` for guided setup, `/meta fix` for SDK upgrades, drift repair, and documentation verification, `/meta deploy` for deployments, `/meta health` for debugging executions. `/work` tracks tasks across sessions, and `/tutorial` guides new developers through a menu-driven multi-track learning path. A `creds` skill auto-triggers when credential setup is needed.
|
|
55
56
|
|
|
56
57
|
See [Agent System](agent.mdx) for CLAUDE.md sections, slash command reference, developer profile, and adaptive guidance tiers.
|
|
57
58
|
|
|
@@ -96,7 +96,7 @@ This file is NOT scaffolded by default. The agent creates it the first time you
|
|
|
96
96
|
|
|
97
97
|
### `docs/in-progress/`
|
|
98
98
|
|
|
99
|
-
Work-in-progress
|
|
99
|
+
Work-in-progress task documents created by `/work create`. Each file represents an active work item with objective, plan, progress markers, and resume context. `/work complete` moves finished items to their permanent location in `docs/`.
|
|
100
100
|
|
|
101
101
|
This directory is NOT deployed -- it is filtered out during the doc scan in `elevasis deploy`.
|
|
102
102
|
|
|
@@ -112,7 +112,7 @@ Only `src/` and `docs/` are scaffolded by `elevasis init`. The following directo
|
|
|
112
112
|
| `src/example/` | `elevasis init` (default) | Always -- echo starter workflow lives here (replace with your own) |
|
|
113
113
|
| `src/shared/` | `elevasis init` (default) | Always -- cross-domain shared utilities (starts empty) |
|
|
114
114
|
| `docs/` | `elevasis init` (default) | Always |
|
|
115
|
-
| `docs/in-progress/` | Agent (on first `/
|
|
115
|
+
| `docs/in-progress/` | Agent (on first `/work create`) | When you create a task doc for in-progress work |
|
|
116
116
|
| `docs/project-map.mdx` | `elevasis deploy` | Auto-generated on every deploy |
|
|
117
117
|
| `docs/priorities.mdx` | Agent (on first goal discussion) | When you discuss project goals or priorities |
|
|
118
118
|
| `data/` | Agent (on demand) | When you connect a database |
|
|
@@ -229,7 +229,7 @@ This directory is gitignored -- it is personal to you and not shared with collab
|
|
|
229
229
|
|
|
230
230
|
## Slash Commands
|
|
231
231
|
|
|
232
|
-
The `.claude/commands/` directory contains
|
|
232
|
+
The `.claude/commands/` directory contains three commands covering the core development loop. Invoke them in Claude Code with `/meta`, `/work`, and `/tutorial`.
|
|
233
233
|
|
|
234
234
|
### `/meta` -- Project Lifecycle
|
|
235
235
|
|
|
@@ -241,15 +241,6 @@ Manages the full lifecycle of your workspace. Five operations:
|
|
|
241
241
|
- **`deploy`** -- Full 9-step deploy pipeline: validate, type-check, verify docs, commit, deploy (auto-regenerates `docs/project-map.mdx`), verify platform, update deployment state, and optionally push.
|
|
242
242
|
- **`health`** -- Execution debugging and resource status; shows recent executions, analyzes failures, and checks environment connectivity.
|
|
243
243
|
|
|
244
|
-
### `/docs` -- Documentation Lifecycle
|
|
245
|
-
|
|
246
|
-
Manages documentation creation and maintenance for `docs/`. Four operations:
|
|
247
|
-
|
|
248
|
-
- **No arguments** -- Review existing `docs/` files and suggest improvements. Identifies undocumented resources, missing descriptions, and structural gaps.
|
|
249
|
-
- **`create <page-name>`** -- Scaffold a new documentation page with correct frontmatter, populated from your resource definitions.
|
|
250
|
-
- **`review`** -- Review all `docs/` files for accuracy against actual resource definitions. Flags mismatches between documented schemas and code.
|
|
251
|
-
- **`verify [path]`** -- Cross-reference documentation with the codebase. Reports discrepancies against actual resource IDs, schema fields, and platform tools.
|
|
252
|
-
|
|
253
244
|
### `/work` -- Task Tracking
|
|
254
245
|
|
|
255
246
|
Manages in-progress task tracking across sessions using `docs/in-progress/` task documents. Five operations:
|
|
@@ -281,7 +272,8 @@ Not all scaffolded files participate in template updates. Files fall into two ca
|
|
|
281
272
|
|
|
282
273
|
**MANAGED** (14 files) -- Written during `elevasis init` and checked/updatable by `elevasis update`:
|
|
283
274
|
- `elevasis.config.ts`, `.gitignore`, `CLAUDE.md`, `.claude/settings.json`
|
|
284
|
-
-
|
|
275
|
+
- One hook: `.claude/hooks/enforce-sdk-boundary.mjs`
|
|
276
|
+
- Three command files: `.claude/commands/meta.md`, `.claude/commands/tutorial.md`, `.claude/commands/work.md`
|
|
285
277
|
- One skill: `.claude/skills/creds/SKILL.md`
|
|
286
278
|
- Five rule files: `.claude/rules/sdk-patterns.md`, `.claude/rules/docs-authoring.md`, `.claude/rules/memory-conventions.md`, `.claude/rules/project-map.md`, `.claude/rules/task-tracking.md`
|
|
287
279
|
|
|
@@ -28,13 +28,11 @@ Hard limits to prevent abuse and ensure platform stability:
|
|
|
28
28
|
|
|
29
29
|
| Limit | Value |
|
|
30
30
|
| ----- | ----- |
|
|
31
|
-
| Max resources per org | 50 |
|
|
32
31
|
| Max execution duration (workflows) | 300s (5 min) |
|
|
33
32
|
| Max execution duration (agents) | 600s (10 min) |
|
|
34
33
|
| Max log volume | 100MB/day |
|
|
35
34
|
| Max deploy frequency | 60/day |
|
|
36
35
|
|
|
37
|
-
- **Resources per org:** The combined count of all workflows and agents across your organization cannot exceed 50.
|
|
38
36
|
- **Execution duration:** Executions exceeding the timeout are terminated by the platform. The execution is marked failed with a timeout reason.
|
|
39
37
|
- **Log volume:** Total log output across all executions is capped at 100MB per day. Logs beyond this threshold may be truncated.
|
|
40
38
|
- **Deploy frequency:** 60 deploys per day is generous for normal development. This limit prevents accidental deploy loops (for example, a CI pipeline misconfigured to deploy on every commit).
|
|
@@ -74,4 +72,4 @@ Organization creation is currently admin-only. If you need a new organization pr
|
|
|
74
72
|
|
|
75
73
|
---
|
|
76
74
|
|
|
77
|
-
**Last Updated:** 2026-
|
|
75
|
+
**Last Updated:** 2026-03-03
|