@elevasis/sdk 0.5.13 → 0.5.14
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 +53 -38
- package/dist/index.d.ts +8 -0
- package/dist/index.js +15 -0
- package/dist/templates.js +36 -36
- package/package.json +1 -1
- package/reference/cli.mdx +568 -505
- package/reference/concepts.mdx +4 -43
- package/reference/deployment/api.mdx +297 -297
- package/reference/deployment/command-center.mdx +9 -12
- package/reference/deployment/index.mdx +7 -7
- package/reference/framework/agent.mdx +6 -18
- package/reference/framework/interaction-guidance.mdx +182 -182
- package/reference/framework/memory.mdx +3 -24
- package/reference/framework/project-structure.mdx +277 -298
- package/reference/framework/tutorial-system.mdx +13 -44
- package/reference/getting-started.mdx +152 -148
- package/reference/index.mdx +28 -14
- package/reference/platform-tools/adapters.mdx +868 -1072
- package/reference/platform-tools/index.mdx +3 -3
- package/reference/resources/index.mdx +339 -341
- package/reference/resources/patterns.mdx +355 -354
- package/reference/resources/types.mdx +207 -207
- package/reference/roadmap.mdx +163 -147
- package/reference/runtime.mdx +2 -25
- package/reference/troubleshooting.mdx +223 -210
package/dist/cli.cjs
CHANGED
|
@@ -43478,6 +43478,21 @@ var ResourceRegistry = class {
|
|
|
43478
43478
|
}
|
|
43479
43479
|
return null;
|
|
43480
43480
|
}
|
|
43481
|
+
/**
|
|
43482
|
+
* Get statistics about remotely-deployed resources
|
|
43483
|
+
* Used by the health endpoint for platform-wide deployment visibility.
|
|
43484
|
+
*/
|
|
43485
|
+
getRemoteStats() {
|
|
43486
|
+
const orgs = /* @__PURE__ */ new Set();
|
|
43487
|
+
for (const key of this.remoteResources.keys()) {
|
|
43488
|
+
const orgName = key.split("/")[0];
|
|
43489
|
+
orgs.add(orgName);
|
|
43490
|
+
}
|
|
43491
|
+
return {
|
|
43492
|
+
activeOrgs: orgs.size,
|
|
43493
|
+
totalResources: this.remoteResources.size
|
|
43494
|
+
};
|
|
43495
|
+
}
|
|
43481
43496
|
// ============================================================================
|
|
43482
43497
|
// Resource Manifest Accessors
|
|
43483
43498
|
// ============================================================================
|
|
@@ -43783,7 +43798,7 @@ async function apiDelete(endpoint, apiUrl = resolveApiUrl()) {
|
|
|
43783
43798
|
// package.json
|
|
43784
43799
|
var package_default = {
|
|
43785
43800
|
name: "@elevasis/sdk",
|
|
43786
|
-
version: "0.5.
|
|
43801
|
+
version: "0.5.14",
|
|
43787
43802
|
description: "SDK for building Elevasis organization resources",
|
|
43788
43803
|
type: "module",
|
|
43789
43804
|
bin: {
|
|
@@ -45450,16 +45465,16 @@ proactivity -- to their assessed levels.
|
|
|
45450
45465
|
|
|
45451
45466
|
| Resource | Location | When to Load |
|
|
45452
45467
|
| --- | --- | --- |
|
|
45453
|
-
| Workspace concepts | \`reference/concepts
|
|
45468
|
+
| Workspace concepts | \`reference/concepts.mdx\` | User asks "what is...?" or needs conceptual grounding |
|
|
45454
45469
|
| SDK patterns and examples | \`reference/resources/patterns.mdx\` | Building or modifying a workflow |
|
|
45455
45470
|
| Platform tool catalog | \`reference/platform-tools/index.mdx\` | Connecting to external services |
|
|
45456
|
-
| CLI reference | \`reference/cli
|
|
45457
|
-
| Credential model | \`reference/
|
|
45458
|
-
| Interaction guidance | \`reference/
|
|
45471
|
+
| CLI reference | \`reference/cli.mdx\` | Running execution/platform operations |
|
|
45472
|
+
| Credential model | \`reference/platform-tools/index.mdx\` | Setting up integrations or credential security |
|
|
45473
|
+
| Interaction guidance | \`reference/framework/interaction-guidance.mdx\` | Unsure how to adapt for a skill combination |
|
|
45459
45474
|
| Error history | \`.claude/memory/errors/index.md\` | Debugging errors, checking past fixes |
|
|
45460
|
-
| Command View model | \`reference/deployment/command-
|
|
45461
|
-
| Command Center UI reference | \`reference/deployment/command-center
|
|
45462
|
-
| SDK error reference | \`reference/troubleshooting
|
|
45475
|
+
| Command View model | \`reference/deployment/command-center.mdx\` | Deploying or building resources that invoke other resources |
|
|
45476
|
+
| Command Center UI reference | \`reference/deployment/command-center.mdx\` | User asks about post-deployment UI or Command Center navigation |
|
|
45477
|
+
| SDK error reference | \`reference/troubleshooting.mdx\` | Unknown error not in workspace memory |
|
|
45463
45478
|
| Project map | \`docs/project-map.mdx\` | Session start, project orientation |
|
|
45464
45479
|
| Resource inventory | \`docs/resource-map.mdx\` | Finding a specific resource by name or ID |
|
|
45465
45480
|
| Project priorities | \`docs/priorities.mdx\` | Deciding what to work on next |
|
|
@@ -45485,7 +45500,7 @@ Use \`pnpm exec elevasis-sdk\` for runtime commands (resolves the locally instal
|
|
|
45485
45500
|
- \`pnpm exec elevasis-sdk execution <resource-id> <execution-id>\` -- inspect execution detail
|
|
45486
45501
|
|
|
45487
45502
|
Organization is derived from your API key -- no org prefix needed in the resource ID.
|
|
45488
|
-
For full CLI reference: \`reference/cli
|
|
45503
|
+
For full CLI reference: \`reference/cli.mdx\`
|
|
45489
45504
|
|
|
45490
45505
|
## Rules
|
|
45491
45506
|
|
|
@@ -45500,8 +45515,8 @@ SDK patterns (imports, source structure, platform tools) are auto-loaded from
|
|
|
45500
45515
|
|
|
45501
45516
|
When an error occurs:
|
|
45502
45517
|
1. Check \`.claude/memory/errors/\` first for past fixes
|
|
45503
|
-
2. If new, check \`reference/troubleshooting
|
|
45504
|
-
3. After resolving, record in
|
|
45518
|
+
2. If new, check \`reference/troubleshooting.mdx\`
|
|
45519
|
+
3. After resolving, record in \`.claude/memory/errors/\` with context and fix
|
|
45505
45520
|
4. If an error recurs 3+ times, add a rule to \`.claude/rules/workspace-patterns.md\`${ctx.hasUI ? `
|
|
45506
45521
|
|
|
45507
45522
|
### UI App (\`ui/\`)
|
|
@@ -45533,7 +45548,7 @@ based on what you find.
|
|
|
45533
45548
|
- When growth is observed, note it in the skills.md Growth Log.
|
|
45534
45549
|
|
|
45535
45550
|
For detailed per-dimension adaptation rules, read
|
|
45536
|
-
\`reference/
|
|
45551
|
+
\`reference/framework/interaction-guidance.mdx\`.
|
|
45537
45552
|
|
|
45538
45553
|
## Commands
|
|
45539
45554
|
|
|
@@ -45542,7 +45557,7 @@ For detailed per-dimension adaptation rules, read
|
|
|
45542
45557
|
| \`/meta\` | Project lifecycle: init, status, fix, deploy, health |
|
|
45543
45558
|
| \`/docs\` | Browse, create, and verify permanent documentation |
|
|
45544
45559
|
| \`/work\` | Task tracking: create, save, resume, complete |
|
|
45545
|
-
| \`/tutorial\` | Progressive learning path (
|
|
45560
|
+
| \`/tutorial\` | Progressive learning path (21 items across 4 sections) |
|
|
45546
45561
|
|
|
45547
45562
|
## Skills
|
|
45548
45563
|
|
|
@@ -45575,7 +45590,7 @@ Do not store in \`.claude/memory/\`:
|
|
|
45575
45590
|
|
|
45576
45591
|
### Structure
|
|
45577
45592
|
|
|
45578
|
-
-
|
|
45593
|
+
- \`.claude/memory/index.md\` is the root -- maps to topic files and subdirectories
|
|
45579
45594
|
- Every subdirectory has its own \`index.md\` mapping to children
|
|
45580
45595
|
- Start at the root index and drill down
|
|
45581
45596
|
- When a file outgrows a single document, split into a subdirectory
|
|
@@ -45599,14 +45614,14 @@ Read \`.claude/memory/profile/skills.md\` first. The \`automation\` skill level
|
|
|
45599
45614
|
controls which docs you load and which lesson variant you deliver.
|
|
45600
45615
|
|
|
45601
45616
|
**automation: none**
|
|
45602
|
-
- Load from \`reference/concepts
|
|
45617
|
+
- Load from \`reference/concepts.mdx\`: Glossary, What is a Workflow,
|
|
45603
45618
|
Platform Tools Overview only. Skip Zod, Execution Model, Design Decisions.
|
|
45604
|
-
- Load \`reference/deployment/command-center
|
|
45619
|
+
- Load \`reference/deployment/command-center.mdx\` for UI-first teaching.
|
|
45605
45620
|
- Do NOT load \`reference/resources/patterns.mdx\` or
|
|
45606
45621
|
\`reference/platform-tools/adapters.mdx\` during core lessons.
|
|
45607
45622
|
|
|
45608
45623
|
**automation: low-code**
|
|
45609
|
-
- Load all sections of \`reference/concepts
|
|
45624
|
+
- Load all sections of \`reference/concepts.mdx\`.
|
|
45610
45625
|
- Load \`reference/resources/patterns.mdx\` with Zapier/Make mapping in mind.
|
|
45611
45626
|
- Load \`reference/platform-tools/adapters.mdx\` on-demand (when tools are used).
|
|
45612
45627
|
|
|
@@ -45694,7 +45709,7 @@ Each lesson follows this flow:
|
|
|
45694
45709
|
|
|
45695
45710
|
When automation is none:
|
|
45696
45711
|
Skip the file tour. Start with what Elevasis does for their business -- use analogies
|
|
45697
|
-
from \`reference/
|
|
45712
|
+
from \`reference/framework/interaction-guidance.mdx\` (recipe, assembly line, kitchen
|
|
45698
45713
|
appliance). Explain deployment plainly: "You write the recipe here, then deploy it so
|
|
45699
45714
|
it's live." Deploy the starter echo workflow (\`elevasis-sdk check\` + \`elevasis-sdk deploy\`),
|
|
45700
45715
|
THEN tour the Command Center so the user sees populated pages, not empty ones. Tour:
|
|
@@ -45942,14 +45957,14 @@ Each module follows this flow:
|
|
|
45942
45957
|
## Modules
|
|
45943
45958
|
|
|
45944
45959
|
**Module: hitl -- Human-in-the-Loop**
|
|
45945
|
-
Read: \`reference/deployment/command-center
|
|
45960
|
+
Read: \`reference/deployment/command-center.mdx\` (Command Queue section).
|
|
45946
45961
|
Build: Add an approval gate using \`approval.requestApproval()\`. Test full lifecycle:
|
|
45947
45962
|
trigger, see pending in Command Queue, approve/reject, observe resume.
|
|
45948
45963
|
Key concepts: approval adapter, pending state, Command Queue UI, resume on decision.
|
|
45949
45964
|
Verify: Trigger workflow, open Command Queue, approve, confirm completion.
|
|
45950
45965
|
|
|
45951
45966
|
**Module: schedules -- Task Scheduling**
|
|
45952
|
-
Read: \`reference/deployment/command-center
|
|
45967
|
+
Read: \`reference/deployment/command-center.mdx\` (Task Scheduler section).
|
|
45953
45968
|
Build: Create all three schedule types (Recurring cron, Relative delay, Absolute
|
|
45954
45969
|
datetime). Use \`scheduler\` adapter for in-workflow scheduling.
|
|
45955
45970
|
Key concepts: schedule types, cron syntax, scheduler adapter, Task Scheduler UI.
|
|
@@ -45963,7 +45978,7 @@ Verify: Run workflow, check notification in Command Center, confirm email receiv
|
|
|
45963
45978
|
|
|
45964
45979
|
**Module: integrations -- Real-World Integrations**
|
|
45965
45980
|
Read: \`reference/platform-tools/index.mdx\`, \`reference/platform-tools/adapters.mdx\`,
|
|
45966
|
-
\`reference/
|
|
45981
|
+
\`reference/platform-tools/index.mdx\`.
|
|
45967
45982
|
Build: Pick a real integration adapter based on user's goals (read \`identity.md\`).
|
|
45968
45983
|
Set up credential (OAuth via UI, API key via CLI). Build end-to-end integration workflow.
|
|
45969
45984
|
Key concepts: adapter pattern, credential scoping, error handling for external calls.
|
|
@@ -45972,7 +45987,7 @@ handling with invalid credential.
|
|
|
45972
45987
|
|
|
45973
45988
|
**Module: error-handling -- Error Handling Mastery**
|
|
45974
45989
|
Read: \`reference/resources/patterns.mdx\` (error handling),
|
|
45975
|
-
\`reference/troubleshooting
|
|
45990
|
+
\`reference/troubleshooting.mdx\`.
|
|
45976
45991
|
Build: Create a workflow demonstrating all three error types. Add try/catch,
|
|
45977
45992
|
\`context.logger\`, and error recovery.
|
|
45978
45993
|
Key concepts: ExecutionError, PlatformToolError, ToolingError, recovery patterns.
|
|
@@ -45988,7 +46003,7 @@ Key concepts: context.store, context.logger, domain organization, schema depth.
|
|
|
45988
46003
|
Verify: Run workflow, confirm store values in step output, check logs in Execution Logs.
|
|
45989
46004
|
|
|
45990
46005
|
**Module: composition -- Resource Composition**
|
|
45991
|
-
Read: \`reference/deployment/command-
|
|
46006
|
+
Read: \`reference/deployment/command-center.mdx\`, \`reference/resources/patterns.mdx\`.
|
|
45992
46007
|
Build: Create two workflows where the first triggers the second using
|
|
45993
46008
|
\`execution.trigger()\`. Declare the relationship.
|
|
45994
46009
|
Key concepts: execution.trigger, relationship declarations, Command View graph edges.
|
|
@@ -46136,7 +46151,7 @@ Last Session: {today's date}
|
|
|
46136
46151
|
\`\`\`
|
|
46137
46152
|
|
|
46138
46153
|
Update rules:
|
|
46139
|
-
- \`Current\`: free-form, e.g. "
|
|
46154
|
+
- \`Current\`: free-form, e.g. "7: Using Platform Tools" or "M:integrations" or "20: Rules, Memory, and Customization"
|
|
46140
46155
|
- \`Last Session\`: update to today's date on each \`/tutorial\` invocation
|
|
46141
46156
|
- Completed Lessons: add a row when any numbered item (1-10, 20-21) finishes
|
|
46142
46157
|
- Completed Modules: add a row when any module (items 11-19) finishes
|
|
@@ -46232,9 +46247,9 @@ by the \`<!-- initialized: false -->\` flag in CLAUDE.md, or run manually.
|
|
|
46232
46247
|
- Create \`.claude/memory/profile/preferences.md\` (verbosity, guidance)
|
|
46233
46248
|
|
|
46234
46249
|
4. **Git check**
|
|
46235
|
-
- If \`.git/\` exists: note git is configured in memory/profile/preferences.md
|
|
46250
|
+
- If \`.git/\` exists: note git is configured in .claude/memory/profile/preferences.md
|
|
46236
46251
|
- If \`.git/\` does not exist: suggest \`git init\` and optionally GitHub
|
|
46237
|
-
- If git remote exists: note remote URL in memory/profile/preferences.md
|
|
46252
|
+
- If git remote exists: note remote URL in .claude/memory/profile/preferences.md
|
|
46238
46253
|
|
|
46239
46254
|
5. **Verify project**
|
|
46240
46255
|
Run \`elevasis-sdk check\` to confirm the starter resource is valid.
|
|
@@ -46255,9 +46270,9 @@ by the \`<!-- initialized: false -->\` flag in CLAUDE.md, or run manually.
|
|
|
46255
46270
|
|
|
46256
46271
|
Display a project health summary:
|
|
46257
46272
|
1. Template version (from elevasis.config.ts) and installed SDK version (from package.json). Suggest \`elevasis-sdk update\` to check for updates
|
|
46258
|
-
|
|
46259
|
-
|
|
46260
|
-
|
|
46273
|
+
2. Profile summary (from .claude/memory/profile/skills.md)
|
|
46274
|
+
3. Quick drift check: count of missing managed files, missing gitignore entries
|
|
46275
|
+
4. Last deployment status (from .claude/memory/deployment-state.md if it exists)
|
|
46261
46276
|
|
|
46262
46277
|
### \`/meta fix\` -- Maintenance and Upgrade
|
|
46263
46278
|
|
|
@@ -46275,9 +46290,9 @@ Detect and repair all drift. Optionally upgrades the SDK first.
|
|
|
46275
46290
|
3. **CLAUDE.md sections:** Add missing sections in correct position
|
|
46276
46291
|
4. **Memory structure:** Create base structure if missing, then verify index consistency.
|
|
46277
46292
|
If \`.claude/memory/\` does not exist or is empty:
|
|
46278
|
-
- Create
|
|
46279
|
-
- Create
|
|
46280
|
-
- Create
|
|
46293
|
+
- Create \`.claude/memory/index.md\` (root index with placeholder entries)
|
|
46294
|
+
- Create \`.claude/memory/errors/index.md\` (error category summary, empty tables)
|
|
46295
|
+
- Create \`.claude/memory/errors/deploy.md\`, \`.claude/memory/errors/runtime.md\`, \`.claude/memory/errors/typescript.md\`
|
|
46281
46296
|
If memory exists, verify: every file referenced in an index exists; every file
|
|
46282
46297
|
without an index entry gets one added; broken references are removed.
|
|
46283
46298
|
5. **Documentation verification:** For each file in docs/:
|
|
@@ -46288,7 +46303,7 @@ Detect and repair all drift. Optionally upgrades the SDK first.
|
|
|
46288
46303
|
e. Report discrepancies with suggested fixes
|
|
46289
46304
|
Note: \`/docs verify\` is available for standalone interactive verification outside this pipeline.
|
|
46290
46305
|
6. **Settings consistency:** Verify expected fields
|
|
46291
|
-
7. **Rules health:** Scan
|
|
46306
|
+
7. **Rules health:** Scan \`.claude/memory/errors/\` -- flag any entry that has recurred
|
|
46292
46307
|
3+ times and is not yet in \`.claude/rules/workspace-patterns.md\`.
|
|
46293
46308
|
If \`workspace-patterns.md\` has no rules yet and 5+ resources exist in \`src/\`,
|
|
46294
46309
|
suggest adding patterns. Surface suggestions only -- do not auto-generate.
|
|
@@ -46301,7 +46316,7 @@ Each step reports its result. Steps 1-8 run even if step 0 is skipped.
|
|
|
46301
46316
|
|
|
46302
46317
|
### \`/meta deploy\` -- Full Deploy Pipeline
|
|
46303
46318
|
|
|
46304
|
-
0. Read \`reference/deployment/command-
|
|
46319
|
+
0. Read \`reference/deployment/command-center.mdx\` -- understand the Command View
|
|
46305
46320
|
model, relationship declarations, and what deploy-time validation checks.
|
|
46306
46321
|
This context is essential for diagnosing validation failures in steps 1-2.
|
|
46307
46322
|
1. Run \`elevasis-sdk check\` (validation)
|
|
@@ -46311,18 +46326,18 @@ Each step reports its result. Steps 1-8 run even if step 0 is skipped.
|
|
|
46311
46326
|
5. Run \`elevasis-sdk deploy\`
|
|
46312
46327
|
6. \`docs/project-map.mdx\` is auto-regenerated by deploy (no manual bump needed)
|
|
46313
46328
|
7. Verify deployment via platform
|
|
46314
|
-
8. Update
|
|
46329
|
+
8. Update \`.claude/memory/deployment-state.md\` with count, timestamp, inventory
|
|
46315
46330
|
9. If git configured and remote exists: optionally push
|
|
46316
46331
|
|
|
46317
46332
|
Each step reports its result. Pipeline stops on failure with suggested fix.
|
|
46318
|
-
If validation fails with relationship errors, re-read \`reference/deployment/command-
|
|
46333
|
+
If validation fails with relationship errors, re-read \`reference/deployment/command-center.mdx\`
|
|
46319
46334
|
for the enforcement model and common fixes.
|
|
46320
46335
|
|
|
46321
46336
|
### \`/meta health\` -- Execution Debugging
|
|
46322
46337
|
|
|
46323
46338
|
Diagnose runtime failures and environment issues:
|
|
46324
46339
|
- Show recent executions with status (completed/failed)
|
|
46325
|
-
- For failed executions: analyze logs, cross-reference with memory/errors/
|
|
46340
|
+
- For failed executions: analyze logs, cross-reference with .claude/memory/errors/
|
|
46326
46341
|
- Check resource deployment status (deployed, outdated, never deployed)
|
|
46327
46342
|
- Verify environment: API key valid, credentials accessible, DB connected
|
|
46328
46343
|
|
|
@@ -46829,7 +46844,7 @@ This file is yours. The other \`.claude/rules/\` files are SDK-owned and updated
|
|
|
46829
46844
|
|
|
46830
46845
|
## When to Add a Rule
|
|
46831
46846
|
|
|
46832
|
-
- An error has recurred 3+ times (CLAUDE.md instructs you to promote from
|
|
46847
|
+
- An error has recurred 3+ times (CLAUDE.md instructs you to promote from \`.claude/memory/errors/\`)
|
|
46833
46848
|
- A pattern appears across 3+ resources and is worth documenting for consistency
|
|
46834
46849
|
- A naming or structural convention exists that future sessions would likely get wrong
|
|
46835
46850
|
|
package/dist/index.d.ts
CHANGED
|
@@ -3124,6 +3124,14 @@ declare class ResourceRegistry {
|
|
|
3124
3124
|
* @returns Remote config or null if org has no remote resources
|
|
3125
3125
|
*/
|
|
3126
3126
|
getAnyRemoteConfig(orgName: string): RemoteOrgConfig | null;
|
|
3127
|
+
/**
|
|
3128
|
+
* Get statistics about remotely-deployed resources
|
|
3129
|
+
* Used by the health endpoint for platform-wide deployment visibility.
|
|
3130
|
+
*/
|
|
3131
|
+
getRemoteStats(): {
|
|
3132
|
+
activeOrgs: number;
|
|
3133
|
+
totalResources: number;
|
|
3134
|
+
};
|
|
3127
3135
|
/**
|
|
3128
3136
|
* Get triggers for an organization
|
|
3129
3137
|
* @param organizationName - Organization name
|
package/dist/index.js
CHANGED
|
@@ -3410,6 +3410,21 @@ var ResourceRegistry = class {
|
|
|
3410
3410
|
}
|
|
3411
3411
|
return null;
|
|
3412
3412
|
}
|
|
3413
|
+
/**
|
|
3414
|
+
* Get statistics about remotely-deployed resources
|
|
3415
|
+
* Used by the health endpoint for platform-wide deployment visibility.
|
|
3416
|
+
*/
|
|
3417
|
+
getRemoteStats() {
|
|
3418
|
+
const orgs = /* @__PURE__ */ new Set();
|
|
3419
|
+
for (const key of this.remoteResources.keys()) {
|
|
3420
|
+
const orgName = key.split("/")[0];
|
|
3421
|
+
orgs.add(orgName);
|
|
3422
|
+
}
|
|
3423
|
+
return {
|
|
3424
|
+
activeOrgs: orgs.size,
|
|
3425
|
+
totalResources: this.remoteResources.size
|
|
3426
|
+
};
|
|
3427
|
+
}
|
|
3413
3428
|
// ============================================================================
|
|
3414
3429
|
// Resource Manifest Accessors
|
|
3415
3430
|
// ============================================================================
|
package/dist/templates.js
CHANGED
|
@@ -257,16 +257,16 @@ proactivity -- to their assessed levels.
|
|
|
257
257
|
|
|
258
258
|
| Resource | Location | When to Load |
|
|
259
259
|
| --- | --- | --- |
|
|
260
|
-
| Workspace concepts | \`reference/concepts
|
|
260
|
+
| Workspace concepts | \`reference/concepts.mdx\` | User asks "what is...?" or needs conceptual grounding |
|
|
261
261
|
| SDK patterns and examples | \`reference/resources/patterns.mdx\` | Building or modifying a workflow |
|
|
262
262
|
| Platform tool catalog | \`reference/platform-tools/index.mdx\` | Connecting to external services |
|
|
263
|
-
| CLI reference | \`reference/cli
|
|
264
|
-
| Credential model | \`reference/
|
|
265
|
-
| Interaction guidance | \`reference/
|
|
263
|
+
| CLI reference | \`reference/cli.mdx\` | Running execution/platform operations |
|
|
264
|
+
| Credential model | \`reference/platform-tools/index.mdx\` | Setting up integrations or credential security |
|
|
265
|
+
| Interaction guidance | \`reference/framework/interaction-guidance.mdx\` | Unsure how to adapt for a skill combination |
|
|
266
266
|
| Error history | \`.claude/memory/errors/index.md\` | Debugging errors, checking past fixes |
|
|
267
|
-
| Command View model | \`reference/deployment/command-
|
|
268
|
-
| Command Center UI reference | \`reference/deployment/command-center
|
|
269
|
-
| SDK error reference | \`reference/troubleshooting
|
|
267
|
+
| Command View model | \`reference/deployment/command-center.mdx\` | Deploying or building resources that invoke other resources |
|
|
268
|
+
| Command Center UI reference | \`reference/deployment/command-center.mdx\` | User asks about post-deployment UI or Command Center navigation |
|
|
269
|
+
| SDK error reference | \`reference/troubleshooting.mdx\` | Unknown error not in workspace memory |
|
|
270
270
|
| Project map | \`docs/project-map.mdx\` | Session start, project orientation |
|
|
271
271
|
| Resource inventory | \`docs/resource-map.mdx\` | Finding a specific resource by name or ID |
|
|
272
272
|
| Project priorities | \`docs/priorities.mdx\` | Deciding what to work on next |
|
|
@@ -292,7 +292,7 @@ Use \`pnpm exec elevasis-sdk\` for runtime commands (resolves the locally instal
|
|
|
292
292
|
- \`pnpm exec elevasis-sdk execution <resource-id> <execution-id>\` -- inspect execution detail
|
|
293
293
|
|
|
294
294
|
Organization is derived from your API key -- no org prefix needed in the resource ID.
|
|
295
|
-
For full CLI reference: \`reference/cli
|
|
295
|
+
For full CLI reference: \`reference/cli.mdx\`
|
|
296
296
|
|
|
297
297
|
## Rules
|
|
298
298
|
|
|
@@ -307,8 +307,8 @@ SDK patterns (imports, source structure, platform tools) are auto-loaded from
|
|
|
307
307
|
|
|
308
308
|
When an error occurs:
|
|
309
309
|
1. Check \`.claude/memory/errors/\` first for past fixes
|
|
310
|
-
2. If new, check \`reference/troubleshooting
|
|
311
|
-
3. After resolving, record in
|
|
310
|
+
2. If new, check \`reference/troubleshooting.mdx\`
|
|
311
|
+
3. After resolving, record in \`.claude/memory/errors/\` with context and fix
|
|
312
312
|
4. If an error recurs 3+ times, add a rule to \`.claude/rules/workspace-patterns.md\`${ctx.hasUI ? `
|
|
313
313
|
|
|
314
314
|
### UI App (\`ui/\`)
|
|
@@ -340,7 +340,7 @@ based on what you find.
|
|
|
340
340
|
- When growth is observed, note it in the skills.md Growth Log.
|
|
341
341
|
|
|
342
342
|
For detailed per-dimension adaptation rules, read
|
|
343
|
-
\`reference/
|
|
343
|
+
\`reference/framework/interaction-guidance.mdx\`.
|
|
344
344
|
|
|
345
345
|
## Commands
|
|
346
346
|
|
|
@@ -349,7 +349,7 @@ For detailed per-dimension adaptation rules, read
|
|
|
349
349
|
| \`/meta\` | Project lifecycle: init, status, fix, deploy, health |
|
|
350
350
|
| \`/docs\` | Browse, create, and verify permanent documentation |
|
|
351
351
|
| \`/work\` | Task tracking: create, save, resume, complete |
|
|
352
|
-
| \`/tutorial\` | Progressive learning path (
|
|
352
|
+
| \`/tutorial\` | Progressive learning path (21 items across 4 sections) |
|
|
353
353
|
|
|
354
354
|
## Skills
|
|
355
355
|
|
|
@@ -382,7 +382,7 @@ Do not store in \`.claude/memory/\`:
|
|
|
382
382
|
|
|
383
383
|
### Structure
|
|
384
384
|
|
|
385
|
-
-
|
|
385
|
+
- \`.claude/memory/index.md\` is the root -- maps to topic files and subdirectories
|
|
386
386
|
- Every subdirectory has its own \`index.md\` mapping to children
|
|
387
387
|
- Start at the root index and drill down
|
|
388
388
|
- When a file outgrows a single document, split into a subdirectory
|
|
@@ -406,14 +406,14 @@ Read \`.claude/memory/profile/skills.md\` first. The \`automation\` skill level
|
|
|
406
406
|
controls which docs you load and which lesson variant you deliver.
|
|
407
407
|
|
|
408
408
|
**automation: none**
|
|
409
|
-
- Load from \`reference/concepts
|
|
409
|
+
- Load from \`reference/concepts.mdx\`: Glossary, What is a Workflow,
|
|
410
410
|
Platform Tools Overview only. Skip Zod, Execution Model, Design Decisions.
|
|
411
|
-
- Load \`reference/deployment/command-center
|
|
411
|
+
- Load \`reference/deployment/command-center.mdx\` for UI-first teaching.
|
|
412
412
|
- Do NOT load \`reference/resources/patterns.mdx\` or
|
|
413
413
|
\`reference/platform-tools/adapters.mdx\` during core lessons.
|
|
414
414
|
|
|
415
415
|
**automation: low-code**
|
|
416
|
-
- Load all sections of \`reference/concepts
|
|
416
|
+
- Load all sections of \`reference/concepts.mdx\`.
|
|
417
417
|
- Load \`reference/resources/patterns.mdx\` with Zapier/Make mapping in mind.
|
|
418
418
|
- Load \`reference/platform-tools/adapters.mdx\` on-demand (when tools are used).
|
|
419
419
|
|
|
@@ -501,7 +501,7 @@ Each lesson follows this flow:
|
|
|
501
501
|
|
|
502
502
|
When automation is none:
|
|
503
503
|
Skip the file tour. Start with what Elevasis does for their business -- use analogies
|
|
504
|
-
from \`reference/
|
|
504
|
+
from \`reference/framework/interaction-guidance.mdx\` (recipe, assembly line, kitchen
|
|
505
505
|
appliance). Explain deployment plainly: "You write the recipe here, then deploy it so
|
|
506
506
|
it's live." Deploy the starter echo workflow (\`elevasis-sdk check\` + \`elevasis-sdk deploy\`),
|
|
507
507
|
THEN tour the Command Center so the user sees populated pages, not empty ones. Tour:
|
|
@@ -749,14 +749,14 @@ Each module follows this flow:
|
|
|
749
749
|
## Modules
|
|
750
750
|
|
|
751
751
|
**Module: hitl -- Human-in-the-Loop**
|
|
752
|
-
Read: \`reference/deployment/command-center
|
|
752
|
+
Read: \`reference/deployment/command-center.mdx\` (Command Queue section).
|
|
753
753
|
Build: Add an approval gate using \`approval.requestApproval()\`. Test full lifecycle:
|
|
754
754
|
trigger, see pending in Command Queue, approve/reject, observe resume.
|
|
755
755
|
Key concepts: approval adapter, pending state, Command Queue UI, resume on decision.
|
|
756
756
|
Verify: Trigger workflow, open Command Queue, approve, confirm completion.
|
|
757
757
|
|
|
758
758
|
**Module: schedules -- Task Scheduling**
|
|
759
|
-
Read: \`reference/deployment/command-center
|
|
759
|
+
Read: \`reference/deployment/command-center.mdx\` (Task Scheduler section).
|
|
760
760
|
Build: Create all three schedule types (Recurring cron, Relative delay, Absolute
|
|
761
761
|
datetime). Use \`scheduler\` adapter for in-workflow scheduling.
|
|
762
762
|
Key concepts: schedule types, cron syntax, scheduler adapter, Task Scheduler UI.
|
|
@@ -770,7 +770,7 @@ Verify: Run workflow, check notification in Command Center, confirm email receiv
|
|
|
770
770
|
|
|
771
771
|
**Module: integrations -- Real-World Integrations**
|
|
772
772
|
Read: \`reference/platform-tools/index.mdx\`, \`reference/platform-tools/adapters.mdx\`,
|
|
773
|
-
\`reference/
|
|
773
|
+
\`reference/platform-tools/index.mdx\`.
|
|
774
774
|
Build: Pick a real integration adapter based on user's goals (read \`identity.md\`).
|
|
775
775
|
Set up credential (OAuth via UI, API key via CLI). Build end-to-end integration workflow.
|
|
776
776
|
Key concepts: adapter pattern, credential scoping, error handling for external calls.
|
|
@@ -779,7 +779,7 @@ handling with invalid credential.
|
|
|
779
779
|
|
|
780
780
|
**Module: error-handling -- Error Handling Mastery**
|
|
781
781
|
Read: \`reference/resources/patterns.mdx\` (error handling),
|
|
782
|
-
\`reference/troubleshooting
|
|
782
|
+
\`reference/troubleshooting.mdx\`.
|
|
783
783
|
Build: Create a workflow demonstrating all three error types. Add try/catch,
|
|
784
784
|
\`context.logger\`, and error recovery.
|
|
785
785
|
Key concepts: ExecutionError, PlatformToolError, ToolingError, recovery patterns.
|
|
@@ -795,7 +795,7 @@ Key concepts: context.store, context.logger, domain organization, schema depth.
|
|
|
795
795
|
Verify: Run workflow, confirm store values in step output, check logs in Execution Logs.
|
|
796
796
|
|
|
797
797
|
**Module: composition -- Resource Composition**
|
|
798
|
-
Read: \`reference/deployment/command-
|
|
798
|
+
Read: \`reference/deployment/command-center.mdx\`, \`reference/resources/patterns.mdx\`.
|
|
799
799
|
Build: Create two workflows where the first triggers the second using
|
|
800
800
|
\`execution.trigger()\`. Declare the relationship.
|
|
801
801
|
Key concepts: execution.trigger, relationship declarations, Command View graph edges.
|
|
@@ -943,7 +943,7 @@ Last Session: {today's date}
|
|
|
943
943
|
\`\`\`
|
|
944
944
|
|
|
945
945
|
Update rules:
|
|
946
|
-
- \`Current\`: free-form, e.g. "
|
|
946
|
+
- \`Current\`: free-form, e.g. "7: Using Platform Tools" or "M:integrations" or "20: Rules, Memory, and Customization"
|
|
947
947
|
- \`Last Session\`: update to today's date on each \`/tutorial\` invocation
|
|
948
948
|
- Completed Lessons: add a row when any numbered item (1-10, 20-21) finishes
|
|
949
949
|
- Completed Modules: add a row when any module (items 11-19) finishes
|
|
@@ -1039,9 +1039,9 @@ by the \`<!-- initialized: false -->\` flag in CLAUDE.md, or run manually.
|
|
|
1039
1039
|
- Create \`.claude/memory/profile/preferences.md\` (verbosity, guidance)
|
|
1040
1040
|
|
|
1041
1041
|
4. **Git check**
|
|
1042
|
-
- If \`.git/\` exists: note git is configured in memory/profile/preferences.md
|
|
1042
|
+
- If \`.git/\` exists: note git is configured in .claude/memory/profile/preferences.md
|
|
1043
1043
|
- If \`.git/\` does not exist: suggest \`git init\` and optionally GitHub
|
|
1044
|
-
- If git remote exists: note remote URL in memory/profile/preferences.md
|
|
1044
|
+
- If git remote exists: note remote URL in .claude/memory/profile/preferences.md
|
|
1045
1045
|
|
|
1046
1046
|
5. **Verify project**
|
|
1047
1047
|
Run \`elevasis-sdk check\` to confirm the starter resource is valid.
|
|
@@ -1062,9 +1062,9 @@ by the \`<!-- initialized: false -->\` flag in CLAUDE.md, or run manually.
|
|
|
1062
1062
|
|
|
1063
1063
|
Display a project health summary:
|
|
1064
1064
|
1. Template version (from elevasis.config.ts) and installed SDK version (from package.json). Suggest \`elevasis-sdk update\` to check for updates
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1065
|
+
2. Profile summary (from .claude/memory/profile/skills.md)
|
|
1066
|
+
3. Quick drift check: count of missing managed files, missing gitignore entries
|
|
1067
|
+
4. Last deployment status (from .claude/memory/deployment-state.md if it exists)
|
|
1068
1068
|
|
|
1069
1069
|
### \`/meta fix\` -- Maintenance and Upgrade
|
|
1070
1070
|
|
|
@@ -1082,9 +1082,9 @@ Detect and repair all drift. Optionally upgrades the SDK first.
|
|
|
1082
1082
|
3. **CLAUDE.md sections:** Add missing sections in correct position
|
|
1083
1083
|
4. **Memory structure:** Create base structure if missing, then verify index consistency.
|
|
1084
1084
|
If \`.claude/memory/\` does not exist or is empty:
|
|
1085
|
-
- Create
|
|
1086
|
-
- Create
|
|
1087
|
-
- Create
|
|
1085
|
+
- Create \`.claude/memory/index.md\` (root index with placeholder entries)
|
|
1086
|
+
- Create \`.claude/memory/errors/index.md\` (error category summary, empty tables)
|
|
1087
|
+
- Create \`.claude/memory/errors/deploy.md\`, \`.claude/memory/errors/runtime.md\`, \`.claude/memory/errors/typescript.md\`
|
|
1088
1088
|
If memory exists, verify: every file referenced in an index exists; every file
|
|
1089
1089
|
without an index entry gets one added; broken references are removed.
|
|
1090
1090
|
5. **Documentation verification:** For each file in docs/:
|
|
@@ -1095,7 +1095,7 @@ Detect and repair all drift. Optionally upgrades the SDK first.
|
|
|
1095
1095
|
e. Report discrepancies with suggested fixes
|
|
1096
1096
|
Note: \`/docs verify\` is available for standalone interactive verification outside this pipeline.
|
|
1097
1097
|
6. **Settings consistency:** Verify expected fields
|
|
1098
|
-
7. **Rules health:** Scan
|
|
1098
|
+
7. **Rules health:** Scan \`.claude/memory/errors/\` -- flag any entry that has recurred
|
|
1099
1099
|
3+ times and is not yet in \`.claude/rules/workspace-patterns.md\`.
|
|
1100
1100
|
If \`workspace-patterns.md\` has no rules yet and 5+ resources exist in \`src/\`,
|
|
1101
1101
|
suggest adding patterns. Surface suggestions only -- do not auto-generate.
|
|
@@ -1108,7 +1108,7 @@ Each step reports its result. Steps 1-8 run even if step 0 is skipped.
|
|
|
1108
1108
|
|
|
1109
1109
|
### \`/meta deploy\` -- Full Deploy Pipeline
|
|
1110
1110
|
|
|
1111
|
-
0. Read \`reference/deployment/command-
|
|
1111
|
+
0. Read \`reference/deployment/command-center.mdx\` -- understand the Command View
|
|
1112
1112
|
model, relationship declarations, and what deploy-time validation checks.
|
|
1113
1113
|
This context is essential for diagnosing validation failures in steps 1-2.
|
|
1114
1114
|
1. Run \`elevasis-sdk check\` (validation)
|
|
@@ -1118,18 +1118,18 @@ Each step reports its result. Steps 1-8 run even if step 0 is skipped.
|
|
|
1118
1118
|
5. Run \`elevasis-sdk deploy\`
|
|
1119
1119
|
6. \`docs/project-map.mdx\` is auto-regenerated by deploy (no manual bump needed)
|
|
1120
1120
|
7. Verify deployment via platform
|
|
1121
|
-
8. Update
|
|
1121
|
+
8. Update \`.claude/memory/deployment-state.md\` with count, timestamp, inventory
|
|
1122
1122
|
9. If git configured and remote exists: optionally push
|
|
1123
1123
|
|
|
1124
1124
|
Each step reports its result. Pipeline stops on failure with suggested fix.
|
|
1125
|
-
If validation fails with relationship errors, re-read \`reference/deployment/command-
|
|
1125
|
+
If validation fails with relationship errors, re-read \`reference/deployment/command-center.mdx\`
|
|
1126
1126
|
for the enforcement model and common fixes.
|
|
1127
1127
|
|
|
1128
1128
|
### \`/meta health\` -- Execution Debugging
|
|
1129
1129
|
|
|
1130
1130
|
Diagnose runtime failures and environment issues:
|
|
1131
1131
|
- Show recent executions with status (completed/failed)
|
|
1132
|
-
- For failed executions: analyze logs, cross-reference with memory/errors/
|
|
1132
|
+
- For failed executions: analyze logs, cross-reference with .claude/memory/errors/
|
|
1133
1133
|
- Check resource deployment status (deployed, outdated, never deployed)
|
|
1134
1134
|
- Verify environment: API key valid, credentials accessible, DB connected
|
|
1135
1135
|
|