@elevasis/sdk 0.4.16 → 0.5.1
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 +727 -509
- package/dist/templates.js +44 -328
- package/dist/types/templates.d.ts +1 -1
- package/package.json +10 -10
- package/reference/concepts/index.mdx +1 -1
- package/reference/framework/agent.mdx +62 -88
- package/reference/framework/index.mdx +17 -14
- package/reference/framework/project-structure.mdx +41 -46
- package/reference/getting-started/index.mdx +16 -12
- package/reference/index.mdx +2 -2
- package/reference/resources/index.mdx +80 -33
|
@@ -18,90 +18,73 @@ The file is instruction-driven by design. Non-technical developers should never
|
|
|
18
18
|
|
|
19
19
|
The generated `CLAUDE.md` contains these sections:
|
|
20
20
|
|
|
21
|
-
- **Session Initialization** --
|
|
22
|
-
- **
|
|
23
|
-
- **
|
|
24
|
-
- **
|
|
25
|
-
- **
|
|
26
|
-
- **
|
|
27
|
-
- **
|
|
28
|
-
- **
|
|
29
|
-
- **Adaptive Guidance** -- Behavior rules for Beginner, Intermediate, and Advanced tiers based on skill levels read from `memory/profile/skills.md`.
|
|
21
|
+
- **Session Initialization** -- Checks the `<!-- initialized: false -->` auto-init flag; if false, runs `/meta init` automatically. Otherwise reads `memory/profile/skills.md` for adaptive behavior, reads `memory/index.md` for project context, checks if the template version is current, and suggests `/tutorial` for TypeScript beginners.
|
|
22
|
+
- **Identity** -- Project orientation: what an Elevasis SDK project is, the developer's role, and how to adapt to non-technical users.
|
|
23
|
+
- **Navigation** -- A table mapping concepts to file paths with load conditions (when to load each file). Includes SDK reference docs, credential model, error history, `docs/project-map.mdx`, and `docs/priorities.mdx`.
|
|
24
|
+
- **Rules** -- Points to auto-loaded rule files in `.claude/rules/`. SDK patterns load automatically; project-specific patterns live in `workspace-patterns.md`. Includes error handling protocol.
|
|
25
|
+
- **Interaction Guidance** -- Per-dimension behavior rules derived from `memory/profile/skills.md`. Covers vocabulary, code completeness, explanation depth, and growth logging.
|
|
26
|
+
- **Commands** -- Table of the 4 slash commands with one-line purpose descriptions.
|
|
27
|
+
- **Skills** -- Auto-trigger conditions for the `creds` skill.
|
|
28
|
+
- **Maintaining Memory** -- Hierarchical structure, pruning rules, and what belongs in memory vs. `docs/` vs. `.claude/rules/`.
|
|
30
29
|
|
|
31
30
|
### Session Initialization
|
|
32
31
|
|
|
33
32
|
At the start of every session the agent runs these steps silently before responding:
|
|
34
33
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
34
|
+
0. Check the `<!-- initialized: ... -->` flag at the top of `CLAUDE.md`. If `false`, run the `/meta init` flow automatically. If `true`, proceed with steps below.
|
|
35
|
+
1. Read `.claude/memory/profile/skills.md` -- adapt all responses to the user's assessed skill levels (see Interaction Guidance below).
|
|
36
|
+
2. Read `.claude/memory/index.md` if it exists -- drill into relevant topic files as needed, balancing context relevance against token usage.
|
|
37
|
+
3. Check the installed `@elevasis/sdk` template version against `templateVersion` in `elevasis.config.ts`. If the SDK has a newer version, notify the user and suggest running `/meta fix`.
|
|
38
|
+
4. If `.claude/memory/` does not exist, suggest running `/meta init` to set up the project.
|
|
39
|
+
5. If the user's TypeScript level is beginner (from skills.md) and `.claude/memory/tutorial-progress.md` does not exist, suggest `/tutorial`.
|
|
38
40
|
|
|
39
41
|
## Slash Commands
|
|
40
42
|
|
|
41
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.
|
|
42
44
|
|
|
43
|
-
|
|
45
|
+
Four commands and one skill are scaffolded by `elevasis init` and committed to version control so collaborators get the same experience:
|
|
44
46
|
|
|
45
47
|
| Command | File | Purpose |
|
|
46
48
|
| --- | --- | --- |
|
|
47
|
-
| `/meta` | `meta.md` | Project lifecycle
|
|
48
|
-
| `/docs` | `docs.md` | Documentation lifecycle -- create,
|
|
49
|
-
| `/
|
|
50
|
-
| `/
|
|
51
|
-
| `/templates` | `templates.md` | Workflow template discovery and scaffolding |
|
|
52
|
-
| `/agent` | `agent.md` | Agent development (placeholder for future agent runtime) |
|
|
53
|
-
| `/tutorial` | `tutorial.md` | Progressive learning path for new developers |
|
|
54
|
-
| `/help` | `help.md` | Displays the full command tree and navigation map |
|
|
55
|
-
| `/profile` | `profile.md` | Views and updates the developer profile in `memory/profile/` |
|
|
56
|
-
| `/work` | `work.md` | In-progress task tracking -- save, resume, list |
|
|
49
|
+
| `/meta` | `meta.md` | Project lifecycle -- init, status, fix, deploy, health |
|
|
50
|
+
| `/docs` | `docs.md` | Documentation lifecycle -- create, review, verify |
|
|
51
|
+
| `/work` | `work.md` | Task tracking -- create, save, resume, complete |
|
|
52
|
+
| `/tutorial` | `tutorial.md` | Progressive 7-lesson learning path |
|
|
57
53
|
|
|
58
54
|
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.
|
|
59
55
|
|
|
60
56
|
### `/meta` Command
|
|
61
57
|
|
|
62
|
-
The `/meta` command namespace manages the full project lifecycle. It has
|
|
58
|
+
The `/meta` command namespace manages the full project lifecycle. It has five operations:
|
|
63
59
|
|
|
64
|
-
- **`/meta init`** -- First-run guided setup. Runs after `elevasis init` to install dependencies, configure `.env`, run the
|
|
65
|
-
- **`/meta`** (no arguments) -- Project health status. Shows current template version, SDK version, profile summary,
|
|
66
|
-
- **`/meta
|
|
67
|
-
- **`/meta
|
|
68
|
-
- **`/meta deploy`** -- Full 9-step deploy pipeline: validate, type-check, verify docs, commit, deploy, bump version, verify platform, update deployment state, and optionally push.
|
|
60
|
+
- **`/meta init`** -- First-run guided setup. Runs after `elevasis init` to install dependencies, configure `.env`, run the competency assessment onboarding flow, seed `memory/profile/`, verify the project, and optionally do a first deploy.
|
|
61
|
+
- **`/meta`** (no arguments) -- Project health status. Shows current template version, SDK version, profile summary, a quick drift check, and last deployment status.
|
|
62
|
+
- **`/meta fix`** -- SDK upgrade check and drift repair. Step 0 offers to run `pnpm update @elevasis/sdk` and merge template changes. Steps 1-8 repair drift: missing managed files, gitignore entries, CLAUDE.md sections, memory structure, doc cross-references, settings, rules health, and project map freshness.
|
|
63
|
+
- **`/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.
|
|
69
64
|
- **`/meta health`** -- Execution debugging and resource status; shows recent executions, analyzes failures, and checks environment connectivity.
|
|
70
|
-
- **`/meta develop`** -- Development navigation hub that loads the resource map, SDK reference, and project state; replaces the old standalone `/workflow`, `/tools`, and `/examples` commands.
|
|
71
65
|
|
|
72
66
|
### `/docs` Command
|
|
73
67
|
|
|
74
|
-
The `/docs` command manages
|
|
68
|
+
The `/docs` command manages documentation in `docs/`. It has four operations:
|
|
75
69
|
|
|
76
|
-
- **`/docs`** (no arguments) --
|
|
77
|
-
- **`/docs create
|
|
78
|
-
- **`/docs
|
|
79
|
-
- **`/docs
|
|
80
|
-
- **`/docs resume`** -- Start-of-session review of in-progress docs, priorities, and recent deployment state. Offers to continue work on the highest-priority item.
|
|
81
|
-
- **`/docs verify`** -- 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.
|
|
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.
|
|
82
74
|
|
|
83
|
-
### `/
|
|
75
|
+
### `/work` Command
|
|
84
76
|
|
|
85
|
-
The `/
|
|
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 | blocked | complete`). Operations:
|
|
86
78
|
|
|
87
|
-
- **`/
|
|
88
|
-
- **`/
|
|
89
|
-
- **`/
|
|
90
|
-
- **`/
|
|
91
|
-
- **`/
|
|
92
|
-
- **`/database import`** -- Import CSV or JSON data into a table. Validates column mapping before writing.
|
|
79
|
+
- **`/work`** (no arguments) -- List all task documents sorted by status and last updated.
|
|
80
|
+
- **`/work create <description>`** -- Create a new task document with Objective, Plan, Progress, and Resume Context sections.
|
|
81
|
+
- **`/work save`** -- Update the current task document with progress made this session. Useful before clearing context.
|
|
82
|
+
- **`/work resume [<name>]`** -- Load a task document and continue from where it left off.
|
|
83
|
+
- **`/work complete`** -- Mark the current task as complete and optionally move the doc to a `completed/` archive.
|
|
93
84
|
|
|
94
|
-
### `/
|
|
85
|
+
### `/tutorial` Command
|
|
95
86
|
|
|
96
|
-
The `/
|
|
97
|
-
|
|
98
|
-
### `/profile` Command
|
|
99
|
-
|
|
100
|
-
The profile command reads from and writes to `memory/profile/`. It has three modes:
|
|
101
|
-
|
|
102
|
-
- **No arguments** -- Displays the current profile in readable format (organization, industry, experience levels, goals, known integrations, preferences) and asks if anything needs updating.
|
|
103
|
-
- **`/profile update`** -- Walks through each profile section, shows current values, and updates only the fields the user wants to change. Writes changes to the appropriate `memory/profile/` file.
|
|
104
|
-
- **`/profile level`** -- Assesses the user's current skill level based on project history (resources created, successful deploys, error handling patterns) and suggests updating `memory/profile/skills.md` if the assessment differs from the stored level.
|
|
87
|
+
The `/tutorial` command runs a 7-lesson guided learning path adapted to the user's skill profile. Each lesson teaches a concept, guides the user to build something, and verifies it works. Lessons cover: project orientation, first custom workflow, schemas, platform tools, multi-step workflows, conditional routing, and going to production.
|
|
105
88
|
|
|
106
89
|
## Developer Profile
|
|
107
90
|
|
|
@@ -109,14 +92,11 @@ The developer profile is stored in `.claude/memory/profile/` as a set of markdow
|
|
|
109
92
|
|
|
110
93
|
### Onboarding Flow
|
|
111
94
|
|
|
112
|
-
Profile data is created during `/meta init`. The command runs a
|
|
95
|
+
Profile data is created during `/meta init`. The command runs a competency assessment (5-7 questions with conditional skipping) and writes the responses to `memory/profile/`:
|
|
113
96
|
|
|
114
|
-
|
|
115
|
-
2
|
|
116
|
-
|
|
117
|
-
4. How would you describe your experience with TypeScript? (beginner / intermediate / advanced)
|
|
118
|
-
5. How familiar are you with AI automation and workflow concepts? (new / some experience / experienced)
|
|
119
|
-
6. Do you prefer detailed explanations or concise responses? (detailed / concise)
|
|
97
|
+
- **Identity & Goals (3 questions):** What the business does, what to automate, which tools are already in use.
|
|
98
|
+
- **Competency (2-3 conditional questions):** Programming background, TypeScript experience (only asked if the user has written scripts or more), automation tool familiarity.
|
|
99
|
+
- **Communication (1 question):** Step-by-step explanations vs. concise answers.
|
|
120
100
|
|
|
121
101
|
### Profile Structure
|
|
122
102
|
|
|
@@ -140,39 +120,33 @@ The agent updates `memory/profile/` files when it observes:
|
|
|
140
120
|
|
|
141
121
|
The agent does not prompt for confirmation on minor updates. Major changes (level upgrades) are surfaced to the user before writing.
|
|
142
122
|
|
|
143
|
-
##
|
|
144
|
-
|
|
145
|
-
The `CLAUDE.md` Adaptive Guidance section translates the skill levels from `memory/profile/skills.md` into concrete behavior rules. The agent checks the TypeScript level and automation level and applies the matching tier.
|
|
146
|
-
|
|
147
|
-
### Beginner
|
|
148
|
-
|
|
149
|
-
Applies when TypeScript level is `beginner` or automation level is `new`:
|
|
123
|
+
## Rules System
|
|
150
124
|
|
|
151
|
-
-
|
|
152
|
-
- Explain every new concept the first time it appears (TypeScript types, Zod schemas, async/await)
|
|
153
|
-
- After creating a resource, walk through deployment step by step
|
|
154
|
-
- Proactively suggest next steps ("Now let's deploy this" or "Want to test it?")
|
|
155
|
-
- When errors occur, explain both the fix and why it happened
|
|
156
|
-
- Use `/help` to navigate to the relevant SDK reference before suggesting platform tools
|
|
125
|
+
Six rule files are scaffolded in `.claude/rules/`. Rule files are auto-injected by Claude Code when their path patterns match the current file being edited -- no manual loading needed.
|
|
157
126
|
|
|
158
|
-
|
|
127
|
+
| File | Type | When Injected | What It Covers |
|
|
128
|
+
| --- | --- | --- | --- |
|
|
129
|
+
| `sdk-patterns.md` | MANAGED | Any file in `src/` | SDK imports, source structure, runtime, typed adapter patterns |
|
|
130
|
+
| `docs-authoring.md` | MANAGED | Any `.mdx` file in `docs/` | MDX escaping, frontmatter requirements, doc structure |
|
|
131
|
+
| `memory-conventions.md` | MANAGED | Any file in `.claude/memory/` | What belongs in memory, structure, pruning |
|
|
132
|
+
| `project-map.md` | MANAGED | `docs/project-map.mdx` | Auto-generated map conventions, do not edit manually |
|
|
133
|
+
| `task-tracking.md` | MANAGED | Any file in `docs/in-progress/` | `/work` command, task doc format, status values |
|
|
134
|
+
| `workspace-patterns.md` | INIT_ONLY | Any file in the project | Project-specific patterns (starts empty, grows via error promotion) |
|
|
159
135
|
|
|
160
|
-
|
|
136
|
+
MANAGED rules are updated by `elevasis update` when the SDK ships a new version. `workspace-patterns.md` is INIT_ONLY -- it belongs to the project and is never overwritten. When an error recurs 3+ times, the agent promotes a fix into this file so future sessions learn from past mistakes.
|
|
161
137
|
|
|
162
|
-
|
|
163
|
-
- Explain new concepts but not basics (Zod, async/await, TypeScript types)
|
|
164
|
-
- Suggest deployment after resource creation but do not walk through it
|
|
165
|
-
- When errors occur, provide the fix with a one-line explanation
|
|
138
|
+
## Interaction Guidance
|
|
166
139
|
|
|
167
|
-
|
|
140
|
+
The `CLAUDE.md` Interaction Guidance section translates skill dimensions from `memory/profile/skills.md` into concrete behavior rules. Rather than fixed tiers, the agent adapts per dimension:
|
|
168
141
|
|
|
169
|
-
|
|
142
|
+
- **Match vocabulary to level.** Avoid jargon for beginners; be precise for experts. Define technical terms in parentheses the first time they appear.
|
|
143
|
+
- **Show complete code for lower-programming users.** Users below intermediate programming level get full working files, never fragments they can't place.
|
|
144
|
+
- **Explain "why" before "how" for users new to automation.** Users comfortable with code get SDK-specific pattern focus instead.
|
|
145
|
+
- **Leverage domain expertise.** If the user knows sales but not code, ask for business process descriptions and translate.
|
|
146
|
+
- **Log observed growth.** When the agent observes the user doing something they previously needed help with, add an entry to `skills.md` Growth Log.
|
|
170
147
|
|
|
171
|
-
-
|
|
172
|
-
- Focus on edge cases and performance
|
|
173
|
-
- Trust the user to deploy and test independently
|
|
174
|
-
- When errors occur, provide the fix
|
|
148
|
+
For detailed per-dimension adaptation rules, read `reference/developer/interaction-guidance.mdx`.
|
|
175
149
|
|
|
176
150
|
---
|
|
177
151
|
|
|
178
|
-
**Last Updated:** 2026-03-
|
|
152
|
+
**Last Updated:** 2026-03-03
|
|
@@ -14,18 +14,21 @@ Running `elevasis init my-project` produces the following agent infrastructure a
|
|
|
14
14
|
|
|
15
15
|
```
|
|
16
16
|
.claude/
|
|
17
|
-
├── CLAUDE.md # Project instructions for Claude Code
|
|
18
17
|
├── settings.json # autoCompact: false
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
├──
|
|
28
|
-
|
|
18
|
+
├── commands/
|
|
19
|
+
│ ├── docs.md # Documentation lifecycle
|
|
20
|
+
│ ├── meta.md # Project lifecycle (init, fix, deploy, health)
|
|
21
|
+
│ ├── tutorial.md # Progressive 7-lesson learning path
|
|
22
|
+
│ └── work.md # Task tracking
|
|
23
|
+
├── skills/
|
|
24
|
+
│ └── creds/SKILL.md # Credential management (auto-triggers)
|
|
25
|
+
└── rules/
|
|
26
|
+
├── sdk-patterns.md # SDK patterns (auto-loaded for src/ files)
|
|
27
|
+
├── docs-authoring.md # MDX conventions (auto-loaded for docs/ files)
|
|
28
|
+
├── memory-conventions.md # Memory conventions (auto-loaded)
|
|
29
|
+
├── project-map.md # Project map conventions (auto-loaded)
|
|
30
|
+
├── task-tracking.md # Task tracking conventions (auto-loaded)
|
|
31
|
+
└── workspace-patterns.md # Project-specific patterns (grows over time)
|
|
29
32
|
```
|
|
30
33
|
|
|
31
34
|
The `memory/` directory is gitignored -- it is personal to each developer and not shared with collaborators. Everything else in `.claude/` is committed.
|
|
@@ -48,7 +51,7 @@ The agent reads `memory/index.md` at session start and drills into `memory/profi
|
|
|
48
51
|
|
|
49
52
|
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.
|
|
50
53
|
|
|
51
|
-
The `/
|
|
54
|
+
The `/meta` command manages the project lifecycle: `/meta init` for guided setup, `/meta fix` for SDK upgrades and drift repair, `/meta deploy` for deployments, `/meta health` for debugging executions. `/docs` handles documentation maintenance, `/work` tracks tasks across sessions, and `/tutorial` guides new developers through a 7-lesson learning path. A `creds` skill auto-triggers when credential setup is needed.
|
|
52
55
|
|
|
53
56
|
See [Agent System](agent.mdx) for CLAUDE.md sections, slash command reference, developer profile, and adaptive guidance tiers.
|
|
54
57
|
|
|
@@ -88,8 +91,8 @@ See [Agent System](agent.mdx) for the full assessment question set, dimensional
|
|
|
88
91
|
|
|
89
92
|
### Skills Auto-Update
|
|
90
93
|
|
|
91
|
-
The Growth Log in `memory/profile/skills.md` keeps approximately 20 recent entries. The agent adds an entry whenever it observes the user performing something they previously needed help with. When a consistent pattern of growth is observed -- typically after several independent successes -- the agent promotes the observation to a level change in the relevant dimension.
|
|
94
|
+
The Growth Log in `memory/profile/skills.md` keeps approximately 20 recent entries. The agent adds an entry whenever it observes the user performing something they previously needed help with. When a consistent pattern of growth is observed -- typically after several independent successes -- the agent promotes the observation to a level change in the relevant dimension.
|
|
92
95
|
|
|
93
96
|
---
|
|
94
97
|
|
|
95
|
-
**Last Updated:** 2026-
|
|
98
|
+
**Last Updated:** 2026-03-03
|
|
@@ -54,7 +54,7 @@ Project-level configuration. The scaffolded file includes `templateVersion`, whi
|
|
|
54
54
|
import type { ElevasConfig } from '@elevasis/sdk'
|
|
55
55
|
|
|
56
56
|
export default {
|
|
57
|
-
templateVersion:
|
|
57
|
+
templateVersion: 14,
|
|
58
58
|
// defaultStatus: 'dev', // Default status for new resources ('dev' | 'production')
|
|
59
59
|
// dev: { port: 5170 }, // Local API port (internal development only)
|
|
60
60
|
} satisfies ElevasConfig
|
|
@@ -82,11 +82,11 @@ order: 0
|
|
|
82
82
|
|
|
83
83
|
Add more pages by creating additional `.mdx` files in `docs/`. Nested directories create sections: `docs/guides/setup.mdx` becomes a `guides/setup` page under your deployment's documentation.
|
|
84
84
|
|
|
85
|
-
### `docs/
|
|
85
|
+
### `docs/project-map.mdx`
|
|
86
86
|
|
|
87
|
-
Auto-generated
|
|
87
|
+
Auto-generated by `elevasis deploy` on every deploy and by `/meta fix` step 8. Contains a full project snapshot: organization, SDK version, template version, last deploy date, source domains, resource tables (workflows and agents), documentation index, SDK reference summary, commands/rules/skills, memory system listing, and configuration state. The agent reads this file at session start for project orientation.
|
|
88
88
|
|
|
89
|
-
This file is
|
|
89
|
+
This file is fully auto-generated -- do not edit manually. Changes are overwritten on the next deploy.
|
|
90
90
|
|
|
91
91
|
### `docs/priorities.mdx`
|
|
92
92
|
|
|
@@ -113,9 +113,9 @@ Only `src/` and `docs/` are scaffolded by `elevasis init`. The following directo
|
|
|
113
113
|
| `src/shared/` | `elevasis init` (default) | Always -- cross-domain shared utilities (starts empty) |
|
|
114
114
|
| `docs/` | `elevasis init` (default) | Always |
|
|
115
115
|
| `docs/in-progress/` | Agent (on first `/docs checkpoint`) | When you save work-in-progress across sessions |
|
|
116
|
-
| `docs/
|
|
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
|
-
| `data/` |
|
|
118
|
+
| `data/` | Agent (on demand) | When you connect a database |
|
|
119
119
|
| `scripts/` | Agent (on demand) | When you need local scripts not deployed to the platform |
|
|
120
120
|
| `src/lib/` | Agent (on demand) | When shared code exists between two or more workflows |
|
|
121
121
|
|
|
@@ -127,7 +127,7 @@ Legacy shared code directory. In v5+ projects, use `src/shared/` for cross-domai
|
|
|
127
127
|
|
|
128
128
|
### `data/`
|
|
129
129
|
|
|
130
|
-
Created by
|
|
130
|
+
Created by the agent when you connect a database. Contains `schema.ts` which documents your database schema as TypeScript types. The agent reads this file to understand your data model when writing workflow steps that call the Supabase tool. Not deployed -- it is local documentation for the agent.
|
|
131
131
|
|
|
132
132
|
### `scripts/`
|
|
133
133
|
|
|
@@ -229,48 +229,40 @@ 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 four commands covering the core development loop. Invoke them in Claude Code with `/meta`, `/docs`, `/work`, and `/tutorial`.
|
|
233
233
|
|
|
234
|
-
### `/
|
|
235
|
-
|
|
236
|
-
Manages documentation creation and maintenance for `docs/`. Six operations:
|
|
237
|
-
|
|
238
|
-
- **No arguments** -- Show current documentation status: pages in progress, recent changes, and stale entries flagged for review
|
|
239
|
-
- **`create <page-name>`** -- Scaffold a new documentation page with correct frontmatter, populated from your resource definitions
|
|
240
|
-
- **`checkpoint`** -- Save current work progress for session resume. Creates or updates `docs/in-progress/` with current state, decisions made, remaining work, and blockers
|
|
241
|
-
- **`cleanup`** -- Move completed documents from `docs/in-progress/` to their final location. Rebuilds `docs/navigation.mdx`
|
|
242
|
-
- **`resume`** -- Start-of-session review of in-progress docs, priorities, and recent deployment state
|
|
243
|
-
- **`verify`** -- Cross-reference documentation with the codebase. Reports discrepancies against actual resource IDs, schema fields, and platform tools
|
|
234
|
+
### `/meta` -- Project Lifecycle
|
|
244
235
|
|
|
245
|
-
|
|
236
|
+
Manages the full lifecycle of your workspace. Five operations:
|
|
246
237
|
|
|
247
|
-
|
|
238
|
+
- **`init`** -- First-run guided setup: installs dependencies, configures `.env`, runs competency assessment to build your developer profile in `.claude/memory/`, and optionally deploys the starter workflow. Triggered automatically by the `<!-- initialized: false -->` flag in CLAUDE.md.
|
|
239
|
+
- **No arguments** -- Project health status: shows template version, SDK version, profile summary, last deployment status, and a quick drift check for missing files.
|
|
240
|
+
- **`fix`** -- SDK upgrade check and full drift repair. Step 0 offers to run `pnpm update @elevasis/sdk` and merge template changes. Steps 1-8 repair drift: missing managed files, gitignore entries, CLAUDE.md sections, memory structure, doc cross-references, settings, rules health, and project map freshness.
|
|
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
|
+
- **`health`** -- Execution debugging and resource status; shows recent executions, analyzes failures, and checks environment connectivity.
|
|
248
243
|
|
|
249
|
-
|
|
250
|
-
- **`multi-step <name>`** -- Multi-step workflow with `StepType.LINEAR` or `StepType.CONDITIONAL`, connected steps, and per-step schemas
|
|
251
|
-
- **`tool-step <name>`** -- Step that calls a platform tool via `platform.call()` with `PlatformToolError` error handling and a credential note
|
|
244
|
+
### `/docs` -- Documentation Lifecycle
|
|
252
245
|
|
|
253
|
-
|
|
246
|
+
Manages documentation creation and maintenance for `docs/`. Four operations:
|
|
254
247
|
|
|
255
|
-
|
|
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.
|
|
256
252
|
|
|
257
|
-
|
|
258
|
-
- **No arguments** -- Project health status: shows template version, SDK version, profile summary, and a quick drift check for missing files
|
|
259
|
-
- **`update`** -- Full upgrade flow: runs `pnpm update @elevasis/sdk`, then `elevasis update` to add missing files, then reviews and merges any flagged template changes with your customizations intact
|
|
260
|
-
- **`fix`** -- Repairs drift without a version upgrade: restores missing command files, appends missing `.gitignore` entries, verifies CLAUDE.md sections, and checks memory structure consistency
|
|
261
|
-
- **`deploy`** -- Full 9-step deploy pipeline: validate, type-check, verify docs, commit, deploy, bump version, verify platform, update deployment state, and optionally push
|
|
262
|
-
- **`health`** -- Execution debugging and resource status; shows recent executions, analyzes failures, and checks environment connectivity
|
|
263
|
-
- **`develop`** -- Development navigation hub that loads the resource map, SDK reference, and project state
|
|
253
|
+
### `/work` -- Task Tracking
|
|
264
254
|
|
|
265
|
-
|
|
255
|
+
Manages in-progress task tracking across sessions using `docs/in-progress/` task documents. Five operations:
|
|
266
256
|
|
|
267
|
-
|
|
257
|
+
- **No arguments** -- List all task documents sorted by status.
|
|
258
|
+
- **`create <description>`** -- Create a new task document with Objective, Plan, Progress, and Resume Context sections.
|
|
259
|
+
- **`save`** -- Update the current task document with progress made this session.
|
|
260
|
+
- **`resume [<name>]`** -- Load a task document and continue from where it left off.
|
|
261
|
+
- **`complete`** -- Mark the current task as complete.
|
|
268
262
|
|
|
269
|
-
|
|
270
|
-
- **`<category>`** -- Show templates in a category with descriptions
|
|
271
|
-
- **`apply <name>`** -- Generate a workflow from a template: writes to the appropriate domain directory, wires into the domain barrel, prompts for credential setup if needed, and runs `elevasis check` to validate
|
|
263
|
+
### `/tutorial` -- Progressive Learning
|
|
272
264
|
|
|
273
|
-
|
|
265
|
+
A 7-lesson guided learning path adapted to the user's skill profile. Lessons cover project orientation, writing workflows, schemas, platform tools, multi-step workflows, conditional routing, and production deployment.
|
|
274
266
|
|
|
275
267
|
---
|
|
276
268
|
|
|
@@ -278,19 +270,22 @@ Templates are documentation files bundled with the SDK, not rigid copy-paste cod
|
|
|
278
270
|
|
|
279
271
|
Not all scaffolded files participate in template updates. Files fall into two categories:
|
|
280
272
|
|
|
281
|
-
**SCAFFOLD_FILES total:
|
|
273
|
+
**SCAFFOLD_FILES total: 29**
|
|
282
274
|
|
|
283
|
-
**INIT_ONLY** (
|
|
275
|
+
**INIT_ONLY** (15 files) -- Written once during `elevasis init`, never updated by `elevasis update`:
|
|
284
276
|
- `package.json`, `pnpm-workspace.yaml`, `tsconfig.json`
|
|
285
277
|
- `.env`, `.env.example`, `.npmrc`
|
|
286
278
|
- `src/index.ts`, `src/operations/platform-status.ts`, `src/operations/index.ts`, `src/example/echo.ts`, `src/example/index.ts`, `src/shared/.gitkeep`
|
|
287
279
|
- `docs/index.mdx`, `docs/in-progress/.gitkeep`
|
|
280
|
+
- `.claude/rules/workspace-patterns.md`
|
|
288
281
|
|
|
289
|
-
**MANAGED** (
|
|
290
|
-
- `elevasis.config.ts`, `.gitignore`, `CLAUDE.md`,
|
|
291
|
-
-
|
|
282
|
+
**MANAGED** (14 files) -- Written during `elevasis init` and checked/updatable by `elevasis update`:
|
|
283
|
+
- `elevasis.config.ts`, `.gitignore`, `CLAUDE.md`, `.claude/settings.json`
|
|
284
|
+
- Four command files: `.claude/commands/docs.md`, `.claude/commands/meta.md`, `.claude/commands/tutorial.md`, `.claude/commands/work.md`
|
|
285
|
+
- One skill: `.claude/skills/creds/SKILL.md`
|
|
286
|
+
- 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`
|
|
292
287
|
|
|
293
|
-
Run `elevasis update` after installing a new SDK version to bring managed files up to date. The command adds missing files directly and flags files that differ from the new template for agent-assisted review via `/meta
|
|
288
|
+
Run `elevasis update` after installing a new SDK version to bring managed files up to date. The command adds missing files directly and flags files that differ from the new template for agent-assisted review via `/meta fix`.
|
|
294
289
|
|
|
295
290
|
---
|
|
296
291
|
|
|
@@ -301,7 +296,7 @@ Run `elevasis update` after installing a new SDK version to bring managed files
|
|
|
301
296
|
| `src/index.ts` | Adding or removing resources (the `/resource` command does this automatically) |
|
|
302
297
|
| `src/<domain>/*.ts` | Writing and modifying workflow logic (organized by business domain) |
|
|
303
298
|
| `docs/index.mdx` | Updating project documentation |
|
|
304
|
-
| `docs/
|
|
299
|
+
| `docs/project-map.mdx` | Never -- auto-generated by `elevasis deploy` |
|
|
305
300
|
| `docs/priorities.mdx` | When goals or priorities change |
|
|
306
301
|
| `elevasis.config.ts` | Changing project-level settings |
|
|
307
302
|
| `.env` | Adding environment variables |
|
|
@@ -310,4 +305,4 @@ Run `elevasis update` after installing a new SDK version to bring managed files
|
|
|
310
305
|
|
|
311
306
|
---
|
|
312
307
|
|
|
313
|
-
**Last Updated:** 2026-
|
|
308
|
+
**Last Updated:** 2026-03-03
|
|
@@ -29,23 +29,27 @@ elevasis init my-project
|
|
|
29
29
|
cd my-project
|
|
30
30
|
```
|
|
31
31
|
|
|
32
|
-
The command scaffolds
|
|
32
|
+
The command scaffolds 29 files covering configuration, source, documentation, and Claude Code integration:
|
|
33
33
|
|
|
34
34
|
```
|
|
35
35
|
my-project/
|
|
36
36
|
├── CLAUDE.md # Project instructions for Claude Code
|
|
37
37
|
├── .claude/
|
|
38
38
|
│ ├── settings.json # autoCompact: false
|
|
39
|
-
│
|
|
40
|
-
│
|
|
41
|
-
│
|
|
42
|
-
│
|
|
43
|
-
│
|
|
44
|
-
│
|
|
45
|
-
│
|
|
46
|
-
│
|
|
47
|
-
│ ├──
|
|
48
|
-
│
|
|
39
|
+
│ ├── commands/
|
|
40
|
+
│ │ ├── docs.md # Documentation lifecycle
|
|
41
|
+
│ │ ├── meta.md # Project lifecycle (init, fix, deploy, health)
|
|
42
|
+
│ │ ├── tutorial.md # Progressive learning
|
|
43
|
+
│ │ └── work.md # Task tracking
|
|
44
|
+
│ ├── skills/
|
|
45
|
+
│ │ └── creds/SKILL.md # Credential management (auto-triggers)
|
|
46
|
+
│ └── rules/
|
|
47
|
+
│ ├── sdk-patterns.md # SDK imports, structure, runtime (auto-loaded)
|
|
48
|
+
│ ├── docs-authoring.md # MDX conventions (auto-loaded)
|
|
49
|
+
│ ├── memory-conventions.md # Memory system conventions (auto-loaded)
|
|
50
|
+
│ ├── project-map.md # Project map conventions (auto-loaded)
|
|
51
|
+
│ ├── task-tracking.md # Task tracking conventions (auto-loaded)
|
|
52
|
+
│ └── workspace-patterns.md # Project-specific patterns (you add these)
|
|
49
53
|
├── src/
|
|
50
54
|
│ ├── index.ts # Registry entry point (aggregates domain barrels)
|
|
51
55
|
│ ├── operations/
|
|
@@ -76,7 +80,7 @@ The scaffolded `elevasis.config.ts` includes a `templateVersion` field that trac
|
|
|
76
80
|
import type { ElevasConfig } from '@elevasis/sdk'
|
|
77
81
|
|
|
78
82
|
export default {
|
|
79
|
-
templateVersion:
|
|
83
|
+
templateVersion: 14,
|
|
80
84
|
} satisfies ElevasConfig
|
|
81
85
|
```
|
|
82
86
|
|
package/reference/index.mdx
CHANGED
|
@@ -53,7 +53,7 @@ export const resources: OrganizationResources = {
|
|
|
53
53
|
## What You Can Build
|
|
54
54
|
|
|
55
55
|
- **Workflows** -- Step-based automation with typed inputs and outputs. Steps can be linear, conditional, or branching. Each step is a plain async function. Workflows are the primary resource type and are fully supported.
|
|
56
|
-
- **Agents** -- Autonomous AI resources with access to platform tools.
|
|
56
|
+
- **Agents** -- Autonomous AI resources with access to platform tools. Agents run in the worker runtime with full LLM access and platform tool support. Use `--async` when executing agents to avoid HTTP timeout limits on long-running runs.
|
|
57
57
|
|
|
58
58
|
## Platform Tools
|
|
59
59
|
|
|
@@ -76,8 +76,8 @@ See [Platform Tools](platform-tools/index.mdx) for the full catalog.
|
|
|
76
76
|
|
|
77
77
|
## Known Limitations
|
|
78
78
|
|
|
79
|
-
- **Agent execution is deferred** -- The worker runtime returns a failed status for agent resources. LLM calls are available via `platform.call`, but autonomous multi-turn agent loops are not yet supported.
|
|
80
79
|
- **No streaming logs** -- Execution logs are returned in the response body after completion. Real-time log streaming is not available.
|
|
80
|
+
- **Agent HTTP timeouts** -- Use `elevasis exec --async` for agent executions. Agents can run for minutes; the synchronous endpoint will time out for long-running runs. The `--async` flag returns an execution ID immediately and polls for the result.
|
|
81
81
|
|
|
82
82
|
## Documentation
|
|
83
83
|
|