@elevasis/sdk 0.5.10 → 0.5.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cli.cjs +249 -280
- package/dist/index.d.ts +3 -4
- package/dist/index.js +5 -29
- package/dist/templates.js +191 -187
- package/dist/worker/index.js +79 -22
- package/package.json +1 -3
- package/reference/_navigation.md +3 -3
- package/reference/cli/index.mdx +51 -45
- package/reference/concepts/index.mdx +2 -2
- package/reference/deployment/api.mdx +8 -8
- package/reference/deployment/command-center-ui.mdx +4 -4
- package/reference/deployment/command-view.mdx +3 -3
- package/reference/deployment/index.mdx +7 -7
- package/reference/framework/agent.mdx +4 -4
- package/reference/framework/documentation.mdx +7 -7
- package/reference/framework/index.mdx +2 -2
- package/reference/framework/memory.mdx +1 -1
- package/reference/framework/project-structure.mdx +20 -30
- package/reference/getting-started/index.mdx +20 -32
- package/reference/index.mdx +6 -5
- package/reference/platform-tools/index.mdx +4 -4
- package/reference/resources/index.mdx +3 -3
- package/reference/resources/patterns.mdx +3 -3
- package/reference/resources/types.mdx +2 -2
- package/reference/roadmap/index.mdx +1 -1
- package/reference/runtime/index.mdx +3 -3
- package/reference/security/credentials.mdx +3 -3
- package/reference/troubleshooting/common-errors.mdx +3 -3
package/dist/templates.js
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
// package.json
|
|
2
2
|
|
|
3
3
|
// src/cli/commands/templates/core/workspace.ts
|
|
4
|
-
var TEMPLATE_VERSION =
|
|
4
|
+
var TEMPLATE_VERSION = 27;
|
|
5
5
|
function configTemplate() {
|
|
6
6
|
return `import type { ElevasConfig } from '@elevasis/sdk'
|
|
7
7
|
|
|
8
8
|
export default {
|
|
9
9
|
templateVersion: ${TEMPLATE_VERSION},
|
|
10
|
-
// defaultStatus: 'dev', // Default status for new resources ('dev' | '
|
|
10
|
+
// defaultStatus: 'dev', // Default status for new resources ('dev' | 'prod')
|
|
11
11
|
// dev: { port: 5170 }, // Local API port (internal development only)
|
|
12
12
|
} satisfies ElevasConfig
|
|
13
13
|
`;
|
|
@@ -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,18 @@ 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 \`
|
|
277
|
+
**MANDATORY:** Use the \`elevasis-sdk\` CLI for all execution/platform operations -- never \`curl\` or any other tool.
|
|
277
278
|
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
- \`
|
|
281
|
-
- \`
|
|
282
|
-
|
|
279
|
+
Use pnpm scripts for check and deploy (they resolve the local binary automatically):
|
|
280
|
+
|
|
281
|
+
- \`pnpm run check\` -- validate resource definitions without deploying
|
|
282
|
+
- \`pnpm run deploy\` -- deploy to the platform
|
|
283
|
+
|
|
284
|
+
Use \`pnpm exec elevasis-sdk\` for runtime commands (resolves the locally installed binary):
|
|
285
|
+
|
|
286
|
+
- \`pnpm exec elevasis-sdk exec <resource-id> --input '{...}'\` -- run a resource synchronously
|
|
287
|
+
- \`pnpm exec elevasis-sdk exec <resource-id> --input '{...}' --async\` -- run async, returns execution ID
|
|
288
|
+
- \`pnpm exec elevasis-sdk execution <resource-id> <execution-id>\` -- inspect execution detail
|
|
283
289
|
|
|
284
290
|
Organization is derived from your API key -- no org prefix needed in the resource ID.
|
|
285
291
|
For full CLI reference: \`reference/cli/index.mdx\`
|
|
@@ -431,32 +437,34 @@ Example (first time, no progress):
|
|
|
431
437
|
Elevasis Tutorial
|
|
432
438
|
==================
|
|
433
439
|
|
|
434
|
-
|
|
435
|
-
1 Welcome & Orientation
|
|
436
|
-
2
|
|
437
|
-
3
|
|
438
|
-
4
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
8
|
|
445
|
-
9
|
|
446
|
-
10
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
17
|
|
456
|
-
18
|
|
457
|
-
19
|
|
458
|
-
|
|
459
|
-
|
|
440
|
+
INTRODUCTION 0/4
|
|
441
|
+
1 Welcome & Orientation [ ]
|
|
442
|
+
2 How This Workspace Works [ ]
|
|
443
|
+
3 The /meta Command [ ]
|
|
444
|
+
4 /work and /docs [ ]
|
|
445
|
+
|
|
446
|
+
CORE CONCEPTS 0/6
|
|
447
|
+
5 Your First Custom Workflow [ ]
|
|
448
|
+
6 Understanding Data (Schemas) [ ]
|
|
449
|
+
7 Using Platform Tools [ ]
|
|
450
|
+
8 Multi-Step Workflows [ ]
|
|
451
|
+
9 Decision Points [ ]
|
|
452
|
+
10 Going to Production [ ]
|
|
453
|
+
|
|
454
|
+
ADVANCED MODULES 0/9
|
|
455
|
+
11 Human-in-the-Loop [ ]
|
|
456
|
+
12 Task Scheduling [ ]
|
|
457
|
+
13 Notification System [ ]
|
|
458
|
+
14 Real-World Integrations [ ]
|
|
459
|
+
15 Error Handling Mastery [ ]
|
|
460
|
+
16 Advanced Workflows [ ]
|
|
461
|
+
17 Resource Composition [ ]
|
|
462
|
+
18 LLM Integration [ ]
|
|
463
|
+
19 AI Agents [ ]
|
|
464
|
+
|
|
465
|
+
ADVANCED WORKSPACE 0/2
|
|
466
|
+
20 Rules, Memory, and Customization [ ]
|
|
467
|
+
21 Template Lifecycle [ ]
|
|
460
468
|
|
|
461
469
|
Pick a number to start.
|
|
462
470
|
\`\`\`
|
|
@@ -469,7 +477,7 @@ indicators from completed/current state. \`"status"\` -> show the same table.
|
|
|
469
477
|
1. Read \`.claude/memory/tutorial-progress.md\`
|
|
470
478
|
2. Show the full menu table (## Menu) with progress filled in
|
|
471
479
|
3. User picks a number -> start or resume that lesson or module directly
|
|
472
|
-
4. After
|
|
480
|
+
4. After user confirms readiness: mark done in progress file, show updated menu table
|
|
473
481
|
5. All 21 items complete -> congratulate, suggest exploring docs/ or /work
|
|
474
482
|
|
|
475
483
|
## Lesson Flow
|
|
@@ -479,18 +487,18 @@ Each lesson follows this flow:
|
|
|
479
487
|
2. Explain the concept (read docs per skill level, adapt to user)
|
|
480
488
|
3. Guide user to build or modify something (agent writes all code for automation: none)
|
|
481
489
|
4. Verify it works (CLI primary for all levels; Command Center for visual review -- Command View, Execution Logs)
|
|
482
|
-
5. Celebrate success,
|
|
483
|
-
6.
|
|
490
|
+
5. Celebrate success and ask: "Any questions, or ready to continue?"
|
|
491
|
+
6. Once the user confirms, record observations in \`.claude/memory/tutorial-progress.md\`
|
|
484
492
|
|
|
485
493
|
## Lessons
|
|
486
494
|
|
|
487
|
-
**
|
|
495
|
+
**Item 1: Welcome & Orientation**
|
|
488
496
|
|
|
489
497
|
When automation is none:
|
|
490
498
|
Skip the file tour. Start with what Elevasis does for their business -- use analogies
|
|
491
499
|
from \`reference/developer/interaction-guidance.mdx\` (recipe, assembly line, kitchen
|
|
492
500
|
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\`),
|
|
501
|
+
it's live." Deploy the starter echo workflow (\`elevasis-sdk check\` + \`elevasis-sdk deploy\`),
|
|
494
502
|
THEN tour the Command Center so the user sees populated pages, not empty ones. Tour:
|
|
495
503
|
Command View (echo node), Execution Logs (result).
|
|
496
504
|
Observation focus: automation value understanding, Command Center comfort.
|
|
@@ -499,52 +507,153 @@ When automation is low-code or custom:
|
|
|
499
507
|
Tour project files: src/index.ts (registry), src/example/echo.ts (starter
|
|
500
508
|
workflow), src/operations/platform-status.ts (platform API example),
|
|
501
509
|
elevasis.config.ts, .env, docs/. Explain the execution model.
|
|
502
|
-
Verify: run \`elevasis resources\`. Then open the Command Center and tour the
|
|
510
|
+
Verify: run \`elevasis-sdk resources\`. Then open the Command Center and tour the
|
|
503
511
|
main pages: Command View (resource graph), Execution Logs.
|
|
504
512
|
Point out the echo workflow node in Command View.
|
|
505
513
|
Observation focus: cloud deployment model, UI navigation comfort.
|
|
506
514
|
|
|
507
|
-
**
|
|
515
|
+
**Item 2: How This Workspace Works**
|
|
516
|
+
|
|
517
|
+
When automation is none:
|
|
518
|
+
"This workspace comes with a built-in assistant that knows your project, your tools,
|
|
519
|
+
and your goals. Let me show you how it's set up." Open CLAUDE.md and explain in
|
|
520
|
+
plain terms: it's the agent's instruction sheet. Point out the commands in the
|
|
521
|
+
Commands table. Show /meta, /tutorial, /work. Explain the creds skill as
|
|
522
|
+
"the assistant automatically helps when you mention API keys." Tour the memory folder
|
|
523
|
+
at a high level -- "this is where the agent stores what it learns about your project."
|
|
524
|
+
Verify: Ask the user a question about their business goal and show how the agent
|
|
525
|
+
references their profile in the answer.
|
|
526
|
+
Observation focus: agent-as-assistant concept, CLAUDE.md as instruction sheet.
|
|
527
|
+
|
|
528
|
+
When automation is low-code:
|
|
529
|
+
Read CLAUDE.md and walk through each section. Explain: what the agent reads on
|
|
530
|
+
session start, how the navigation table works, what the Skills section means.
|
|
531
|
+
Explain the four commands briefly. Show that the agent has memory: open
|
|
532
|
+
\`.claude/memory/profile/skills.md\` and show their own profile -- "every session,
|
|
533
|
+
the agent reads this and adapts." Explain the initialized flag.
|
|
534
|
+
Verify: Run /meta to see project status.
|
|
535
|
+
Observation focus: memory system concept, session initialization flow.
|
|
536
|
+
|
|
537
|
+
When automation is custom:
|
|
538
|
+
Read CLAUDE.md in full. Explain the session initialization sequence: CLAUDE.md ->
|
|
539
|
+
navigation table -> memory files -> context loading. Walk through: Commands section
|
|
540
|
+
(4 commands + creds skill), Rules section (auto-loaded based on file paths), Skills
|
|
541
|
+
section (auto-triggered by content patterns). Point out the initialized flag and
|
|
542
|
+
explain how /meta init set it.
|
|
543
|
+
Verify: Run /meta to see project status; observe which fields it reports.
|
|
544
|
+
Observation focus: initialization model, command-vs-rule-vs-skill distinction.
|
|
545
|
+
|
|
546
|
+
**Item 3: The /meta Command**
|
|
547
|
+
|
|
548
|
+
When automation is none:
|
|
549
|
+
"Think of /meta as your project dashboard -- it shows what's healthy and what needs
|
|
550
|
+
attention." Run /meta (no arguments) and narrate the output in plain language: what
|
|
551
|
+
each field means. Explain /meta fix as "the agent tidies up and applies updates."
|
|
552
|
+
Explain /meta deploy as "the agent publishes your changes in one step." Briefly note
|
|
553
|
+
/meta health shows what happened when something goes wrong.
|
|
554
|
+
Verify: Run /meta (no arguments). Narrate the output together.
|
|
555
|
+
Observation focus: project lifecycle concept, dashboard reading.
|
|
556
|
+
|
|
557
|
+
When automation is low-code:
|
|
558
|
+
Show all /meta operations with their purpose. Map to familiar concepts: /meta fix is
|
|
559
|
+
like "repair this Zap" in Zapier; /meta deploy is a one-command publish pipeline.
|
|
560
|
+
Walk through the /meta (no-args) output: template version (SDK template your workspace
|
|
561
|
+
uses), SDK version (installed package), profile summary, drift check.
|
|
562
|
+
Verify: Run /meta and interpret each field together.
|
|
563
|
+
Observation focus: deploy pipeline understanding, version tracking.
|
|
564
|
+
|
|
565
|
+
When automation is custom:
|
|
566
|
+
Read \`.claude/commands/meta.md\`. Walk through each operation: init (first-run setup
|
|
567
|
+
with assessment), (no-args) (status dashboard), fix (drift repair + SDK upgrade +
|
|
568
|
+
rules health), deploy (7-step pipeline: check, typecheck, docs, git, deploy,
|
|
569
|
+
project-map, verify), health (runtime diagnostics). Explain the merge strategy for
|
|
570
|
+
CLAUDE.md and commands. Note the template access model: templates read from
|
|
571
|
+
@elevasis/sdk/templates subpath.
|
|
572
|
+
Verify: Run /meta to see project status. Identify what a version mismatch looks like.
|
|
573
|
+
Observation focus: full lifecycle coverage, pipeline internals.
|
|
574
|
+
|
|
575
|
+
**Item 4: /work and /docs**
|
|
576
|
+
|
|
577
|
+
When automation is none:
|
|
578
|
+
"You can ask the assistant to track work across conversations. When you start something
|
|
579
|
+
complex, use /work create to save your place. Next session, /work resume picks up where
|
|
580
|
+
you left off." Walk through the concept without deep command details. Then introduce /docs:
|
|
581
|
+
"When a task is finished, /work complete moves it to docs/ permanently. After that, /docs
|
|
582
|
+
helps you find and read what's there -- like a notebook for your project." Run /docs (no
|
|
583
|
+
args) to show the docs/ overview together.
|
|
584
|
+
Verify: Create a task with \`/work create "practice task"\`, then run /work to see it listed.
|
|
585
|
+
Then run /docs to see the docs/ structure.
|
|
586
|
+
Observation focus: persistence concept, cross-session continuity, docs as permanent notes.
|
|
587
|
+
|
|
588
|
+
When automation is low-code:
|
|
589
|
+
Show /work operations: create (task doc with frontmatter + sections), save (updates
|
|
590
|
+
Progress + Resume Context), resume (loads context for next session), complete (moves
|
|
591
|
+
to permanent docs/).
|
|
592
|
+
Then introduce /docs: "/docs is for permanent knowledge -- things that don't expire. Use
|
|
593
|
+
/docs create to document a workflow or integration. Use /docs verify to check if your
|
|
594
|
+
docs match the current code." Explain the boundary: /work manages in-progress/, /docs
|
|
595
|
+
manages permanent docs/.
|
|
596
|
+
Verify: Create a task with \`/work create "practice task"\`, run /work save, inspect the
|
|
597
|
+
file. Then run /docs to browse docs/.
|
|
598
|
+
Observation focus: task tracking workflow, /work vs /docs separation.
|
|
599
|
+
|
|
600
|
+
When automation is custom:
|
|
601
|
+
Read \`.claude/commands/work.md\`. Full /work coverage:
|
|
602
|
+
/work create (kebab-case filename, frontmatter with status, Objective/Plan/Progress/
|
|
603
|
+
Resume Context sections), /work save (Progress + Resume Context update), /work resume
|
|
604
|
+
(multiple-task disambiguation), /work complete (moves to final location).
|
|
605
|
+
Then read \`.claude/commands/docs.md\`. Cover /docs operations:
|
|
606
|
+
/docs (default): browse permanent docs/, categorized with read-only auto-generated files
|
|
607
|
+
separate; /docs create: interview-driven, resource-aware doc creation from src/ code
|
|
608
|
+
analysis; /docs verify: cross-references resource IDs, schema fields, platform tools in
|
|
609
|
+
docs against src/ -- standalone analog of /meta fix step 5.
|
|
610
|
+
Explain the relationship: /work owns docs/in-progress/ (task lifecycle), /work complete
|
|
611
|
+
moves docs to permanent location, /docs browses and verifies what's there.
|
|
612
|
+
Verify: Create a task doc, save progress, run /work complete to move it. Then run /docs
|
|
613
|
+
to see it in the permanent docs/ listing.
|
|
614
|
+
Observation focus: task doc anatomy, /work-to-/docs handoff, docs verification as standalone tool.
|
|
615
|
+
|
|
616
|
+
**Item 5: Your First Custom Workflow**
|
|
508
617
|
|
|
509
618
|
When automation is none:
|
|
510
619
|
Frame the workflow as "a recipe." Use plain language: "settings" not "config",
|
|
511
620
|
"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
|
|
621
|
+
not "entryPoint." Agent writes all code changes. Agent runs \`elevasis-sdk exec\` to verify
|
|
513
622
|
and narrates the result in plain terms.
|
|
514
623
|
Observation focus: recipe-to-result connection.
|
|
515
624
|
|
|
516
625
|
When automation is low-code or custom:
|
|
517
626
|
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
|
|
627
|
+
entryPoint. Deploy: \`elevasis-sdk check\` then \`elevasis-sdk deploy\`. Test with
|
|
628
|
+
\`elevasis-sdk exec echo --input '{"message":"hello"}'\`. Then open the Execution
|
|
520
629
|
Runner in the Command Center, find the echo workflow, fill out the form, and
|
|
521
630
|
run it from the UI. Compare the result to the CLI output.
|
|
522
631
|
Observation focus: deployment-to-execution loop, TypeScript syntax comfort.
|
|
523
632
|
|
|
524
|
-
**
|
|
633
|
+
**Item 6: Understanding Data (Schemas)**
|
|
525
634
|
|
|
526
635
|
When automation is none:
|
|
527
636
|
Frame as "What information does your automation need?" Describe types in plain English:
|
|
528
637
|
text, number, yes/no, a choice from a list. NO Zod, no z.string(), no z.infer(), no
|
|
529
638
|
code shown. Agent reads identity.md goals and writes the workflow schema. Agent runs
|
|
530
|
-
\`elevasis exec\` with sample input and narrates the result.
|
|
639
|
+
\`elevasis-sdk exec\` with sample input and narrates the result.
|
|
531
640
|
Observation focus: data-to-input connection, required vs optional understanding.
|
|
532
641
|
|
|
533
642
|
When automation is low-code:
|
|
534
643
|
"Field mapping like Zapier, but with validation." Show Zod types briefly. Demonstrate
|
|
535
644
|
how \`.describe()\` documents each field. Build schema based on identity.md goals.
|
|
536
|
-
After deploy, run with \`elevasis exec --input '{...}'\` to verify each field.
|
|
645
|
+
After deploy, run with \`elevasis-sdk exec --input '{...}'\` to verify each field.
|
|
537
646
|
Observation focus: schema-to-input mapping, optional fields, types.
|
|
538
647
|
|
|
539
648
|
When automation is custom:
|
|
540
649
|
Explain schemas in plain English (concepts page). Show common Zod types.
|
|
541
650
|
Explain \`z.infer\`. Build a new workflow with real-world input schema based
|
|
542
651
|
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
|
|
652
|
+
run with \`elevasis-sdk exec --input '{...}'\` to verify the schema and inspect
|
|
544
653
|
the execution output.
|
|
545
654
|
Observation focus: schema-to-input mapping, optional fields, types.
|
|
546
655
|
|
|
547
|
-
**
|
|
656
|
+
**Item 7: Using Platform Tools**
|
|
548
657
|
|
|
549
658
|
When automation is none:
|
|
550
659
|
Frame as "Connecting your automation to a service you already use." Pick ONE
|
|
@@ -566,12 +675,12 @@ If using the approval tool, note that pending requests surface in Command Queue.
|
|
|
566
675
|
See reference/platform-tools/adapters.mdx for full API.
|
|
567
676
|
Observation focus: credential setup (CLI + UI), async/await.
|
|
568
677
|
|
|
569
|
-
**
|
|
678
|
+
**Item 8: Multi-Step Workflows**
|
|
570
679
|
|
|
571
680
|
When automation is none:
|
|
572
681
|
Frame as "Step 1 passes its result to Step 2, like a relay race." Command View is
|
|
573
682
|
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.
|
|
683
|
+
the 2-step workflow. Agent runs \`elevasis-sdk exec\` to verify and shows output flow.
|
|
575
684
|
User opens Command View to see the two nodes + arrow. Code is secondary.
|
|
576
685
|
Observation focus: relay-race concept, visual graph comprehension.
|
|
577
686
|
|
|
@@ -582,12 +691,12 @@ relationship edges between resources. Explain how declared relationships map
|
|
|
582
691
|
to the visual graph.
|
|
583
692
|
Observation focus: data flow reasoning, relationship visualization.
|
|
584
693
|
|
|
585
|
-
**
|
|
694
|
+
**Item 9: Decision Points**
|
|
586
695
|
|
|
587
696
|
When automation is none:
|
|
588
697
|
Frame as "If the customer is VIP, do this -- otherwise, do that." No StepType.CONDITIONAL
|
|
589
698
|
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
|
|
699
|
+
Agent runs \`elevasis-sdk exec\` for both paths. Open Execution Logs to see which
|
|
591
700
|
path ran. Guide log navigation step-by-step.
|
|
592
701
|
Observation focus: branching concept understanding, log navigation.
|
|
593
702
|
|
|
@@ -598,7 +707,7 @@ Execution Logs in the Command Center, filter by the resource, and show how
|
|
|
598
707
|
each path appears in the log detail (step trace, input/output).
|
|
599
708
|
Observation focus: branching logic reasoning, execution log interpretation.
|
|
600
709
|
|
|
601
|
-
**
|
|
710
|
+
**Item 10: Going to Production**
|
|
602
711
|
|
|
603
712
|
When automation is none:
|
|
604
713
|
Frame as "draft vs live" not "dev vs production." Error handling: "when something
|
|
@@ -612,12 +721,12 @@ Change status from dev to production. Cover error handling: try/catch,
|
|
|
612
721
|
ExecutionError, PlatformToolError. Create a schedule in Task Scheduler (use
|
|
613
722
|
Recurring type for a cron schedule). If docs/ has pages, show Knowledge Base.
|
|
614
723
|
Open Deployments page to confirm the latest version is active. Show CLI
|
|
615
|
-
monitoring: elevasis executions, elevasis execution. Suggest next steps.
|
|
724
|
+
monitoring: elevasis-sdk executions, elevasis-sdk execution. Suggest next steps.
|
|
616
725
|
Observation focus: readiness for independent operation (CLI + UI).
|
|
617
726
|
|
|
618
727
|
## Module Menu
|
|
619
728
|
|
|
620
|
-
Module order (items
|
|
729
|
+
Module order (items 11-19 in the main menu): hitl, schedules, notifications,
|
|
621
730
|
integrations, error-handling, workflows, composition, llm, agents.
|
|
622
731
|
|
|
623
732
|
After completing a module, show the updated full menu table (## Menu).
|
|
@@ -700,116 +809,16 @@ Read: \`reference/framework/agent.mdx\`.
|
|
|
700
809
|
Build: Create an agent definition with tools. Configure LLM tool calling.
|
|
701
810
|
Compare agent vs workflow for a task.
|
|
702
811
|
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.
|
|
812
|
+
Verify: Run agent with \`elevasis-sdk exec\`, review tool call trace in Execution Logs.
|
|
704
813
|
|
|
705
|
-
##
|
|
814
|
+
## Advanced Workspace Track
|
|
706
815
|
|
|
707
|
-
The
|
|
708
|
-
rules, memory
|
|
709
|
-
can be taken in any order.
|
|
816
|
+
The Advanced Workspace track teaches power-user workspace customization and maintenance --
|
|
817
|
+
rules, memory, and the template lifecycle. Independent of the core path; can be taken at any time.
|
|
710
818
|
|
|
711
|
-
|
|
819
|
+
Each item follows the same flow as core lessons: announce, explain per skill level, verify, record observations.
|
|
712
820
|
|
|
713
|
-
|
|
714
|
-
"This workspace comes with a built-in assistant that knows your project, your tools,
|
|
715
|
-
and your goals. Let me show you how it's set up." Open CLAUDE.md and explain in
|
|
716
|
-
plain terms: it's the agent's instruction sheet. Point out the commands in the
|
|
717
|
-
Commands table. Show /meta, /tutorial, /work. Explain the creds skill as
|
|
718
|
-
"the assistant automatically helps when you mention API keys." Tour the memory folder
|
|
719
|
-
at a high level -- "this is where the agent stores what it learns about your project."
|
|
720
|
-
Verify: Ask the user a question about their business goal and show how the agent
|
|
721
|
-
references their profile in the answer.
|
|
722
|
-
Observation focus: agent-as-assistant concept, CLAUDE.md as instruction sheet.
|
|
723
|
-
|
|
724
|
-
When automation is low-code:
|
|
725
|
-
Read CLAUDE.md and walk through each section. Explain: what the agent reads on
|
|
726
|
-
session start, how the navigation table works, what the Skills section means.
|
|
727
|
-
Explain the four commands briefly. Show that the agent has memory: open
|
|
728
|
-
\`.claude/memory/profile/skills.md\` and show their own profile -- "every session,
|
|
729
|
-
the agent reads this and adapts." Explain the initialized flag.
|
|
730
|
-
Verify: Run /meta to see project status.
|
|
731
|
-
Observation focus: memory system concept, session initialization flow.
|
|
732
|
-
|
|
733
|
-
When automation is custom:
|
|
734
|
-
Read CLAUDE.md in full. Explain the session initialization sequence: CLAUDE.md ->
|
|
735
|
-
navigation table -> memory files -> context loading. Walk through: Commands section
|
|
736
|
-
(4 commands + creds skill), Rules section (auto-loaded based on file paths), Skills
|
|
737
|
-
section (auto-triggered by content patterns). Point out the initialized flag and
|
|
738
|
-
explain how /meta init set it.
|
|
739
|
-
Verify: Run /meta to see project status; observe which fields it reports.
|
|
740
|
-
Observation focus: initialization model, command-vs-rule-vs-skill distinction.
|
|
741
|
-
|
|
742
|
-
**MF2: The /meta Command -- Project Lifecycle**
|
|
743
|
-
|
|
744
|
-
When automation is none:
|
|
745
|
-
"Think of /meta as your project dashboard -- it shows what's healthy and what needs
|
|
746
|
-
attention." Run /meta (no arguments) and narrate the output in plain language: what
|
|
747
|
-
each field means. Explain /meta fix as "the agent tidies up and applies updates."
|
|
748
|
-
Explain /meta deploy as "the agent publishes your changes in one step." Briefly note
|
|
749
|
-
/meta health shows what happened when something goes wrong.
|
|
750
|
-
Verify: Run /meta (no arguments). Narrate the output together.
|
|
751
|
-
Observation focus: project lifecycle concept, dashboard reading.
|
|
752
|
-
|
|
753
|
-
When automation is low-code:
|
|
754
|
-
Show all /meta operations with their purpose. Map to familiar concepts: /meta fix is
|
|
755
|
-
like "repair this Zap" in Zapier; /meta deploy is a one-command publish pipeline.
|
|
756
|
-
Walk through the /meta (no-args) output: template version (SDK template your workspace
|
|
757
|
-
uses), SDK version (installed package), profile summary, drift check.
|
|
758
|
-
Verify: Run /meta and interpret each field together.
|
|
759
|
-
Observation focus: deploy pipeline understanding, version tracking.
|
|
760
|
-
|
|
761
|
-
When automation is custom:
|
|
762
|
-
Read \`.claude/commands/meta.md\`. Walk through each operation: init (first-run setup
|
|
763
|
-
with assessment), (no-args) (status dashboard), fix (drift repair + SDK upgrade +
|
|
764
|
-
rules health), deploy (7-step pipeline: check, typecheck, docs, git, deploy,
|
|
765
|
-
project-map, verify), health (runtime diagnostics). Explain the merge strategy for
|
|
766
|
-
CLAUDE.md and commands. Note the template access model: templates read from
|
|
767
|
-
@elevasis/sdk/templates subpath.
|
|
768
|
-
Verify: Run /meta to see project status. Identify what a version mismatch looks like.
|
|
769
|
-
Observation focus: full lifecycle coverage, pipeline internals.
|
|
770
|
-
|
|
771
|
-
**MF3: /work and /docs -- Task and Documentation Lifecycle**
|
|
772
|
-
|
|
773
|
-
When automation is none:
|
|
774
|
-
"You can ask the assistant to track work across conversations. When you start something
|
|
775
|
-
complex, use /work create to save your place. Next session, /work resume picks up where
|
|
776
|
-
you left off." Walk through the concept without deep command details. Then introduce /docs:
|
|
777
|
-
"When a task is finished, /work complete moves it to docs/ permanently. After that, /docs
|
|
778
|
-
helps you find and read what's there -- like a notebook for your project." Run /docs (no
|
|
779
|
-
args) to show the docs/ overview together.
|
|
780
|
-
Verify: Create a task with \`/work create "practice task"\`, then run /work to see it listed.
|
|
781
|
-
Then run /docs to see the docs/ structure.
|
|
782
|
-
Observation focus: persistence concept, cross-session continuity, docs as permanent notes.
|
|
783
|
-
|
|
784
|
-
When automation is low-code:
|
|
785
|
-
Show /work operations: create (task doc with frontmatter + sections), save (updates
|
|
786
|
-
Progress + Resume Context), resume (loads context for next session), complete (moves
|
|
787
|
-
to permanent docs/).
|
|
788
|
-
Then introduce /docs: "/docs is for permanent knowledge -- things that don't expire. Use
|
|
789
|
-
/docs create to document a workflow or integration. Use /docs verify to check if your
|
|
790
|
-
docs match the current code." Explain the boundary: /work manages in-progress/, /docs
|
|
791
|
-
manages permanent docs/.
|
|
792
|
-
Verify: Create a task with \`/work create "practice task"\`, run /work save, inspect the
|
|
793
|
-
file. Then run /docs to browse docs/.
|
|
794
|
-
Observation focus: task tracking workflow, /work vs /docs separation.
|
|
795
|
-
|
|
796
|
-
When automation is custom:
|
|
797
|
-
Read \`.claude/commands/work.md\`. Full /work coverage:
|
|
798
|
-
/work create (kebab-case filename, frontmatter with status, Objective/Plan/Progress/
|
|
799
|
-
Resume Context sections), /work save (Progress + Resume Context update), /work resume
|
|
800
|
-
(multiple-task disambiguation), /work complete (moves to final location).
|
|
801
|
-
Then read \`.claude/commands/docs.md\`. Cover /docs operations:
|
|
802
|
-
/docs (default): browse permanent docs/, categorized with read-only auto-generated files
|
|
803
|
-
separate; /docs create: interview-driven, resource-aware doc creation from src/ code
|
|
804
|
-
analysis; /docs verify: cross-references resource IDs, schema fields, platform tools in
|
|
805
|
-
docs against src/ -- standalone analog of /meta fix step 5.
|
|
806
|
-
Explain the relationship: /work owns docs/in-progress/ (task lifecycle), /work complete
|
|
807
|
-
moves docs to permanent location, /docs browses and verifies what's there.
|
|
808
|
-
Verify: Create a task doc, save progress, run /work complete to move it. Then run /docs
|
|
809
|
-
to see it in the permanent docs/ listing.
|
|
810
|
-
Observation focus: task doc anatomy, /work-to-/docs handoff, docs verification as standalone tool.
|
|
811
|
-
|
|
812
|
-
**MF4: Rules, Memory, and Customization**
|
|
821
|
+
**Item 20: Rules, Memory, and Customization**
|
|
813
822
|
|
|
814
823
|
When automation is none:
|
|
815
824
|
"The assistant has a set of reminders specific to your project. Over time, when it
|
|
@@ -823,7 +832,7 @@ Observation focus: customization concept, owned vs managed files.
|
|
|
823
832
|
|
|
824
833
|
When automation is low-code:
|
|
825
834
|
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).
|
|
835
|
+
updated by elevasis-sdk update) and workspace-patterns.md (INIT_ONLY -- yours to edit).
|
|
827
836
|
Explain path-scoping briefly: "These rules only activate when the agent is working on
|
|
828
837
|
certain file types." Show an example rule with WRONG/RIGHT pattern. Explain error
|
|
829
838
|
promotion: if something goes wrong 3+ times, add it here.
|
|
@@ -840,7 +849,7 @@ workspace-patterns.md. Walk through how to add a new rule.
|
|
|
840
849
|
Verify: Read \`.claude/rules/workspace-patterns.md\`. Add a sample rule entry together.
|
|
841
850
|
Observation focus: MANAGED vs INIT_ONLY lifecycle, rule authoring, memory layout.
|
|
842
851
|
|
|
843
|
-
**
|
|
852
|
+
**Item 21: Template Lifecycle**
|
|
844
853
|
|
|
845
854
|
When automation is none:
|
|
846
855
|
"When Elevasis SDK releases updates, the assistant can apply them to your workspace
|
|
@@ -853,7 +862,7 @@ Next steps: point to reference docs in docs/, encourage using /work for new task
|
|
|
853
862
|
Observation focus: update model concept, project map as navigation aid.
|
|
854
863
|
|
|
855
864
|
When automation is low-code:
|
|
856
|
-
Explain MANAGED (auto-updated by elevasis update) vs INIT_ONLY (set once, yours).
|
|
865
|
+
Explain MANAGED (auto-updated by elevasis-sdk update) vs INIT_ONLY (set once, yours).
|
|
857
866
|
Show how /meta fix applies SDK updates with conflict handling: "If a file changed,
|
|
858
867
|
it shows you both versions and lets you decide."
|
|
859
868
|
Show \`docs/project-map.mdx\` and explain what it contains: resources, commands,
|
|
@@ -877,7 +886,7 @@ Observation focus: full template lifecycle, conflict resolution pattern.
|
|
|
877
886
|
|
|
878
887
|
**automation: none**
|
|
879
888
|
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.
|
|
889
|
+
never types code. Agent runs \`elevasis-sdk exec\` for verification and narrates results.
|
|
881
890
|
Avoid all jargon; use analogies. CLI is the primary verification tool.
|
|
882
891
|
Always deploy before directing the user to the Command Center.
|
|
883
892
|
|
|
@@ -891,7 +900,7 @@ for intermediate/advanced users.
|
|
|
891
900
|
|
|
892
901
|
**General rules (all levels)**
|
|
893
902
|
- If user is fast, acknowledge and offer to skip ahead within a lesson
|
|
894
|
-
- After
|
|
903
|
+
- After the user confirms readiness at the end of a lesson, update \`.claude/memory/tutorial-progress.md\`
|
|
895
904
|
- If user demonstrates a level change, promote to skills.md Growth Log
|
|
896
905
|
- After completing a module, show the updated full menu table
|
|
897
906
|
- Adapt module depth to skill level as with lessons
|
|
@@ -910,7 +919,7 @@ Last Session: {today's date}
|
|
|
910
919
|
|
|
911
920
|
## Completed Lessons
|
|
912
921
|
|
|
913
|
-
|
|
|
922
|
+
| Item | Title | Completed | Duration |
|
|
914
923
|
| --- | --- | --- | --- |
|
|
915
924
|
|
|
916
925
|
## Completed Modules
|
|
@@ -918,11 +927,6 @@ Last Session: {today's date}
|
|
|
918
927
|
| Module | Title | Completed | Duration |
|
|
919
928
|
| --- | --- | --- | --- |
|
|
920
929
|
|
|
921
|
-
## Completed MF Lessons
|
|
922
|
-
|
|
923
|
-
| Lesson | Title | Completed | Notes |
|
|
924
|
-
| --- | --- | --- | --- |
|
|
925
|
-
|
|
926
930
|
## Capability Observations
|
|
927
931
|
|
|
928
932
|
| Source | Observation |
|
|
@@ -934,13 +938,14 @@ Last Session: {today's date}
|
|
|
934
938
|
\`\`\`
|
|
935
939
|
|
|
936
940
|
Update rules:
|
|
937
|
-
- \`Current\`: free-form, e.g. "
|
|
941
|
+
- \`Current\`: free-form, e.g. "4: Using Platform Tools" or "M:integrations" or "20: Rules, Memory, and Customization"
|
|
938
942
|
- \`Last Session\`: update to today's date on each \`/tutorial\` invocation
|
|
939
|
-
- Completed
|
|
940
|
-
-
|
|
943
|
+
- Completed Lessons: add a row when any numbered item (1-10, 20-21) finishes
|
|
944
|
+
- Completed Modules: add a row when any module (items 11-19) finishes
|
|
945
|
+
- Capability Observations: prefix source with item number for lessons (#), M:<id> for modules
|
|
941
946
|
- Assessment Notes: bullet points of general skill observations
|
|
942
947
|
|
|
943
|
-
Backward-compatible: missing Completed Modules
|
|
948
|
+
Backward-compatible: missing Completed Modules treated as empty. Old files with Completed MF Lessons: map entries to items 2-4 and 20-21 by lesson title match.
|
|
944
949
|
`;
|
|
945
950
|
}
|
|
946
951
|
function claudeMetaCommandTemplate() {
|
|
@@ -973,7 +978,7 @@ by the \`<!-- initialized: false -->\` flag in CLAUDE.md, or run manually.
|
|
|
973
978
|
\`\`\`
|
|
974
979
|
No other keys (no \`NODE_ENV\`, no extras). The \`.env\` file must contain
|
|
975
980
|
only \`ELEVASIS_PLATFORM_KEY\`.
|
|
976
|
-
Validate the key works: run \`elevasis resources\` (should return an empty
|
|
981
|
+
Validate the key works: run \`elevasis-sdk resources\` (should return an empty
|
|
977
982
|
list, not an auth error). If auth fails, tell the user their key appears
|
|
978
983
|
invalid and ask them to check it in the Elevasis dashboard.
|
|
979
984
|
|
|
@@ -1034,7 +1039,7 @@ by the \`<!-- initialized: false -->\` flag in CLAUDE.md, or run manually.
|
|
|
1034
1039
|
- If git remote exists: note remote URL in memory/profile/preferences.md
|
|
1035
1040
|
|
|
1036
1041
|
5. **Verify project**
|
|
1037
|
-
Run \`elevasis check\` to confirm the starter resource is valid.
|
|
1042
|
+
Run \`elevasis-sdk check\` to confirm the starter resource is valid.
|
|
1038
1043
|
Optionally deploy the echo workflow.
|
|
1039
1044
|
|
|
1040
1045
|
6. **Report**
|
|
@@ -1051,8 +1056,7 @@ by the \`<!-- initialized: false -->\` flag in CLAUDE.md, or run manually.
|
|
|
1051
1056
|
### \`/meta\` (no arguments) -- Project Status
|
|
1052
1057
|
|
|
1053
1058
|
Display a project health summary:
|
|
1054
|
-
1.
|
|
1055
|
-
2. SDK package version from package.json
|
|
1059
|
+
1. Template version (from elevasis.config.ts) and installed SDK version (from package.json). Suggest \`elevasis-sdk update\` to check for updates
|
|
1056
1060
|
3. Profile summary (from memory/profile/skills.md)
|
|
1057
1061
|
4. Quick drift check: count of missing managed files, missing gitignore entries
|
|
1058
1062
|
5. Last deployment status (from memory/deployment-state.md if it exists)
|
|
@@ -1063,7 +1067,7 @@ Detect and repair all drift. Optionally upgrades the SDK first.
|
|
|
1063
1067
|
|
|
1064
1068
|
0. **SDK version check** -- Compare installed \`@elevasis/sdk\` against the latest
|
|
1065
1069
|
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
|
|
1070
|
+
continuing. If the user accepts, run it, then run \`elevasis-sdk update\` to add
|
|
1067
1071
|
any new managed files and flag conflicts. For each flagged file:
|
|
1068
1072
|
- Read the current project file and the new template from \`@elevasis/sdk/templates\`
|
|
1069
1073
|
- Add new sections that don't exist; preserve user customizations
|
|
@@ -1092,7 +1096,7 @@ Detect and repair all drift. Optionally upgrades the SDK first.
|
|
|
1092
1096
|
suggest adding patterns. Surface suggestions only -- do not auto-generate.
|
|
1093
1097
|
8. **Project map freshness:** Check whether \`docs/project-map.mdx\` reflects the
|
|
1094
1098
|
current project state (resources, commands, rules, skills, memory files).
|
|
1095
|
-
Compare filesystem state against the map. If stale, run \`elevasis deploy\`
|
|
1099
|
+
Compare filesystem state against the map. If stale, run \`elevasis-sdk deploy\`
|
|
1096
1100
|
to regenerate, or patch inline for minor drift.
|
|
1097
1101
|
|
|
1098
1102
|
Each step reports its result. Steps 1-8 run even if step 0 is skipped.
|
|
@@ -1102,11 +1106,11 @@ Each step reports its result. Steps 1-8 run even if step 0 is skipped.
|
|
|
1102
1106
|
0. Read \`reference/deployment/command-view.mdx\` -- understand the Command View
|
|
1103
1107
|
model, relationship declarations, and what deploy-time validation checks.
|
|
1104
1108
|
This context is essential for diagnosing validation failures in steps 1-2.
|
|
1105
|
-
1. Run \`elevasis check\` (validation)
|
|
1109
|
+
1. Run \`elevasis-sdk check\` (validation)
|
|
1106
1110
|
2. Type check if \`tsconfig.json\` exists
|
|
1107
1111
|
3. Verify docs reflect current resources
|
|
1108
1112
|
4. If git configured: stage changes, commit with deploy message
|
|
1109
|
-
5. Run \`elevasis deploy\`
|
|
1113
|
+
5. Run \`elevasis-sdk deploy\`
|
|
1110
1114
|
6. \`docs/project-map.mdx\` is auto-regenerated by deploy (no manual bump needed)
|
|
1111
1115
|
7. Verify deployment via platform
|
|
1112
1116
|
8. Update \`memory/deployment-state.md\` with count, timestamp, inventory
|
|
@@ -1668,10 +1672,10 @@ description: Project map conventions -- auto-generated, do not edit, maintained
|
|
|
1668
1672
|
|
|
1669
1673
|
# Project Map
|
|
1670
1674
|
|
|
1671
|
-
- \`docs/project-map.mdx\` and \`docs/resource-map.mdx\` are fully auto-generated by \`elevasis deploy\`
|
|
1675
|
+
- \`docs/project-map.mdx\` and \`docs/resource-map.mdx\` are fully auto-generated by \`elevasis-sdk deploy\`
|
|
1672
1676
|
- Do not edit either file manually -- changes are overwritten on next deploy
|
|
1673
1677
|
- \`/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
|
|
1678
|
+
- If a new command, rule, skill, or memory file is added, run \`/meta fix\` or \`elevasis-sdk deploy\` to update
|
|
1675
1679
|
`;
|
|
1676
1680
|
}
|
|
1677
1681
|
function claudeTaskTrackingRuleTemplate() {
|