@elevasis/sdk 0.4.5 → 0.4.7

package/reference/cli/index.mdx

@@ -0,0 +1,497 @@
+---
+title: CLI Reference
+description: Full reference for every elevasis CLI command -- scaffold, validate, deploy, execute, and inspect resources
+loadWhen: "Running CLI operations"
+---
+
+The `elevasis` CLI is the primary interface for working with your Elevasis SDK project. Install it as part of `@elevasis/sdk` and use it to scaffold projects, validate resource definitions, deploy to the platform, and inspect execution history.
+
+**Installation:**
+
+```bash
+npm install @elevasis/sdk
+```
+
+After installation, the `elevasis` binary is available in your project's `node_modules/.bin/`. Most commands require `ELEVASIS_API_KEY` to be set in your environment or a `.env` file.
+
+---
+
+## elevasis init
+
+Scaffold a new Elevasis SDK project in the specified directory.
+
+**Synopsis:**
+
+```
+elevasis init [directory]
+```
+
+**Behavior:**
+
+- Derives the organization slug from the directory name
+- Checks for file conflicts before writing any files
+- Scaffolds project structure including `src/index.ts`, `elevasis.config.ts`, `package.json`, `tsconfig.json`, and a `CLAUDE.md` with CLI reference and SDK patterns
+- Non-interactive: all values are derived automatically
+
+**Flags:**
+
+| Flag | Description |
+| ---- | ----------- |
+| (none) | Uses current directory if no argument is provided |
+
+**Example:**
+
+```bash
+elevasis init my-project
+```
+
+```
+  Scaffolding my-project/...
+
+  Created 23 files.
+
+  Next steps:
+    cd my-project
+    npm install
+    elevasis check
+```
+
+---
+
+## elevasis check
+
+Validate all resource definitions in your project without deploying.
+
+**Synopsis:**
+
+```
+elevasis check
+```
+
+**Behavior:**
+
+- Imports your `src/index.ts` and runs it through `ResourceRegistry` validation
+- Catches the same errors that the platform catches at deploy time:
+  - Duplicate `resourceId` within the organization
+  - Invalid model configuration (temperature and token bounds)
+  - `ExecutionInterface` form fields not matching `inputSchema`
+  - Broken workflow step chains (`next` referencing non-existent steps)
+  - Relationship declarations referencing non-existent resources
+- Exits with code 0 on success, code 1 on validation failure
+
+**Flags:**
+
+| Flag | Description |
+| ---- | ----------- |
+| `--api-url <url>` | Override the API base URL |
+
+**Example output (success):**
+
+```
+$ elevasis check
+
+  Validating...    done (4 resources, 0 errors)
+```
+
+**Example output (failure):**
+
+```
+$ elevasis check
+
+  Validating...
+    ERROR  Duplicate resource ID 'onboard-client' in organization 'Acme Corp'
+    ERROR  Workflow step 'send-email' references non-existent next step 'notify'
+
+  2 errors.
+```
+
+---
+
+## elevasis deploy
+
+Bundle your project with esbuild and deploy it to the Elevasis platform.
+
+**Synopsis:**
+
+```
+elevasis deploy
+```
+
+**Behavior:**
+
+- Authenticates with `ELEVASIS_API_KEY` and resolves your organization name
+- Runs the same `ResourceRegistry` validation as `elevasis check`
+- Bundles your `src/index.ts` and all dependencies into a single self-contained JS file (`dist/bundle.js`, approximately 50-200 KB)
+- Uploads the bundle plus resource metadata to `POST /api/external/deploy`
+- Streams deploy status and prints the result
+- Resources are live immediately after a successful deploy
+
+**Flags:**
+
+| Flag | Description |
+| ---- | ----------- |
+| `--api-url <url>` | Override the API base URL (default: production) |
+
+**Environment variables:**
+
+| Variable | Description |
+| -------- | ----------- |
+| `ELEVASIS_API_KEY` | Required. Your `sk_...` API key |
+| `ELEVASIS_API_URL` | Optional. Override the API base URL |
+
+**Example output (success):**
+
+```
+$ elevasis deploy
+
+  Authenticating...          done (acme-corp)
+  Validating...              done (4 resources, 0 errors)
+  Bundling...                done (142 KB)
+  Uploading...               done
+
+  Deployed! 4 resources live.
+  Deployment: deploy_abc123
+```
+
+**Example output (validation failure):**
+
+```
+$ elevasis deploy
+
+  Authenticating...          done (acme-corp)
+  Validating...
+    ERROR  Duplicate resource ID 'onboard-client' in organization 'Acme Corp'
+    ERROR  Workflow step 'send-email' references non-existent next step 'notify'
+
+  2 errors. Deploy aborted.
+```
+
+---
+
+## elevasis exec
+
+Execute a deployed resource by ID.
+
+**Synopsis:**
+
+```
+elevasis exec <resource> --input '{...}'
+```
+
+**Behavior:**
+
+- Executes the named resource synchronously by default and streams the result
+- Use `--async` to return an `executionId` immediately and poll for completion
+- `--input` accepts a JSON string matching the resource's `inputSchema`
+- Organization is derived from your API key -- no org prefix needed
+
+**Flags:**
+
+| Flag | Description |
+| ---- | ----------- |
+| `--input <json>` | JSON input matching the resource's input schema |
+| `--async` | Execute asynchronously, return execution ID immediately |
+| `--json` | Output raw JSON instead of formatted display |
+| `--api-url <url>` | Override the API base URL |
+
+**Example:**
+
+```bash
+elevasis exec onboard-client --input '{"clientName": "Jane", "email": "jane@example.com"}'
+```
+
+```
+  Executing onboard-client...
+
+  Status:   completed
+  Duration: 1.4s
+
+  Output:
+  {
+    "success": true,
+    "clientId": "client_1708521600000",
+    "welcomeEmailSent": true
+  }
+```
+
+**Async example:**
+
+```bash
+elevasis exec onboard-client --input '{"clientName": "Jane"}' --async
+```
+
+```
+  Execution started: exec_550e8400
+  Poll with: elevasis execution onboard-client exec_550e8400
+```
+
+---
+
+## elevasis resources
+
+List all deployed resources for your organization.
+
+**Synopsis:**
+
+```
+elevasis resources
+```
+
+**Behavior:**
+
+- Lists all resources registered to your organization on the platform
+- In production, only `status: 'prod'` resources are shown
+- Displays resource ID, type, name, and status
+
+**Flags:**
+
+| Flag | Description |
+| ---- | ----------- |
+| `--json` | Output raw JSON |
+| `--api-url <url>` | Override the API base URL |
+
+**Example output:**
+
+```
+$ elevasis resources
+
+  onboard-client    workflow   Onboard Client       prod
+  send-report       workflow   Send Weekly Report   prod
+  email-assistant   agent      Email Assistant      prod
+  support-bot       agent      Support Bot          dev
+```
+
+---
+
+## elevasis executions
+
+View execution history for a resource.
+
+**Synopsis:**
+
+```
+elevasis executions [resource]
+```
+
+**Behavior:**
+
+- Lists recent executions for the specified resource
+- If `resource` is omitted, lists executions across all resources
+- Supports filtering by status and limiting result count
+
+**Flags:**
+
+| Flag | Description |
+| ---- | ----------- |
+| `--limit <n>` | Maximum number of executions to return (default: 20) |
+| `--status <status>` | Filter by status: `running`, `completed`, `failed`, `cancelled` |
+| `--json` | Output raw JSON |
+| `--api-url <url>` | Override the API base URL |
+
+**Example:**
+
+```bash
+elevasis executions onboard-client --limit 5
+```
+
+```
+  exec_abc001   completed   2026-02-25 14:32:01   1.2s
+  exec_abc002   completed   2026-02-25 13:18:44   0.9s
+  exec_abc003   failed      2026-02-25 12:05:22   0.3s
+  exec_abc004   completed   2026-02-24 17:51:09   1.8s
+  exec_abc005   completed   2026-02-24 16:30:55   1.1s
+```
+
+---
+
+## elevasis execution
+
+View full detail for a single execution.
+
+**Synopsis:**
+
+```
+elevasis execution <resource> <id>
+```
+
+**Behavior:**
+
+- Shows the complete execution record: input, output, logs, duration, and error (if any)
+- Use `--json` to get the raw JSON response for programmatic use
+
+**Flags:**
+
+| Flag | Description |
+| ---- | ----------- |
+| `--json` | Output raw JSON |
+| `--api-url <url>` | Override the API base URL |
+
+**Example:**
+
+```bash
+elevasis execution onboard-client exec_abc001
+```
+
+```
+  Resource:   onboard-client
+  Status:     completed
+  Started:    2026-02-25 14:32:01
+  Duration:   1.2s
+
+  Input:
+  {
+    "clientName": "Jane",
+    "email": "jane@example.com"
+  }
+
+  Output:
+  {
+    "success": true,
+    "clientId": "client_1708521600000",
+    "welcomeEmailSent": true
+  }
+
+  Logs:
+  [14:32:01.123]  Starting onboard-client workflow
+  [14:32:01.456]  Created client record
+  [14:32:01.891]  Welcome email sent to jane@example.com
+```
+
+---
+
+## elevasis deployments
+
+List all deployments for your organization.
+
+**Synopsis:**
+
+```
+elevasis deployments
+```
+
+**Behavior:**
+
+- Shows deployment history with status, timestamp, and resource count
+- Active deployment is marked; previous deployments show as `stopped`
+
+**Flags:**
+
+| Flag | Description |
+| ---- | ----------- |
+| `--json` | Output raw JSON |
+| `--api-url <url>` | Override the API base URL |
+
+**Example output:**
+
+```
+$ elevasis deployments
+
+  deploy_abc123   active    2026-02-25 14:00:00   4 resources
+  deploy_abc122   stopped   2026-02-24 09:30:00   3 resources
+  deploy_abc121   stopped   2026-02-23 11:15:00   3 resources
+```
+
+---
+
+## elevasis describe
+
+Show the definition of a deployed resource.
+
+**Synopsis:**
+
+```
+elevasis describe <resource>
+```
+
+**Behavior:**
+
+- Displays resource metadata: name, type, description, status, and domains
+- Shows the full `inputSchema` and `outputSchema` as JSON
+- Type is color-coded: yellow for workflows, magenta for agents
+
+**Flags:**
+
+| Flag | Description |
+| ---- | ----------- |
+| `--json` | Output raw JSON response |
+| `--api-url <url>` | Override the API base URL |
+
+**Example:**
+
+```bash
+elevasis describe onboard-client
+```
+
+```
+  onboard-client  [workflow]
+
+  Name:         Onboard Client
+  Description:  Creates a client record and sends a welcome email
+  Status:       prod
+  Domains:      crm, email
+
+  Input Schema:
+  {
+    "type": "object",
+    "properties": {
+      "clientName": { "type": "string" },
+      "email": { "type": "string", "format": "email" }
+    },
+    "required": ["clientName", "email"]
+  }
+```
+
+---
+
+## elevasis env
+
+Manage environment variables for your project.
+
+**Synopsis:**
+
+```
+elevasis env list
+elevasis env set <key> <value>
+elevasis env remove <key>
+```
+
+**Behavior:**
+
+- `list` -- display all environment variables configured for the project
+- `set` -- add or update an environment variable
+- `remove` -- delete an environment variable
+
+**Flags:**
+
+| Flag | Description |
+| ---- | ----------- |
+| `--api-url <url>` | Override the API base URL |
+
+**Examples:**
+
+```bash
+elevasis env list
+elevasis env set OPENAI_API_KEY sk-proj-***
+elevasis env remove OPENAI_API_KEY
+```
+
+---
+
+## Global Flags
+
+These flags are accepted by all commands:
+
+| Flag | Description |
+| ---- | ----------- |
+| `--api-url <url>` | Override the API base URL. Priority: flag > `ELEVASIS_API_URL` env var > `NODE_ENV`-based default |
+| `--json` | Output raw JSON (available on most commands) |
+
+**API base URL resolution:**
+
+- Production (default): `https://api.elevasis.io`
+- Development (`NODE_ENV=development`): `http://localhost:<port>`
+- Override: set `ELEVASIS_API_URL` or pass `--api-url`
+
+---
+
+**Last Updated:** 2026-02-25

package/reference/concepts/index.mdx

@@ -0,0 +1,203 @@
+---
+title: Concepts Reference
+description: Plain-English explanations of Elevasis SDK concepts -- glossary, workflow analogies, Zod schemas, execution model, platform tools, common errors, and design decisions
+loadWhen: "User asks what is or needs conceptual grounding"
+---
+
+This page covers core Elevasis concepts in plain English. It is the teaching vocabulary for the agent when helping you build workflows, and a reference you can return to whenever a term or behavior is unclear.
+
+## Glossary
+
+| Term | Definition |
+| --- | --- |
+| Workflow | A series of named steps that run one after another. Each step does one job. The workflow receives input data and produces output data. |
+| Agent | An autonomous AI resource with access to platform tools. Agents can make decisions and call tools on their own. (Execution deferred -- see Known Limitations in the SDK overview.) |
+| Resource | Anything you deploy to the platform -- a workflow or an agent. Each resource has a unique ID. |
+| Step | One job inside a workflow. A step receives data, processes it, and passes data to the next step. |
+| Schema | A description of what your data looks like. Schemas validate that input and output data has the right shape -- the right fields with the right types. |
+| Credential | A saved API key or login for an external service (Gmail, Attio, Stripe). Stored securely on the platform, never in your code. |
+| Execution | One run of a resource. Each time someone triggers your workflow, that is one execution. |
+| Deployment | The act of uploading your code to the platform. After deploying, your resources are live and can be executed. |
+| Platform Tool | A pre-built integration the platform provides. You call platform tools from your workflow steps using `platform.call()`. |
+| Organization | Your team or company on the Elevasis platform. Resources, credentials, and executions belong to an organization. |
+| Handler | The function inside a step that does the actual work. It receives input data and returns output data. |
+| Entry Point | The first step that runs when a workflow is executed. Every workflow must have one. |
+| Resource ID | A unique lowercase name for your resource (e.g., `lead-scorer`, `send-welcome-email`). Must be unique within your organization. |
+| Workspace | Your Elevasis project directory. Contains resources (workflows and agents), documentation, and optionally a database connection and custom apps. Created by `elevasis init`. |
+| Data Table | A table in your database (e.g., Supabase) that stores structured data your workflows can read and write. Defined in `data/schema.ts` as documentation for the agent. |
+
+---
+
+## What is a Workflow?
+
+A workflow is a piece of automation that runs on the Elevasis platform. You define the steps in TypeScript; the platform handles running them, logging results, and retrying on failure.
+
+### Two Analogies
+
+**Recipe analogy:** A recipe has ingredients (input), instructions (steps), and a finished dish (output). Each instruction is one step. You follow them in order. If a step fails (you burn the sauce), the recipe stops.
+
+**Assembly line analogy:** Raw material goes in one end (input). Each station does one job (step). The finished product comes out the other end (output).
+
+### When to Use a Workflow
+
+- Automating a repeatable task with defined input and output
+- Chaining multiple actions together (fetch data, process it, send an email)
+- When you need the platform to handle execution, retries, and logging
+
+### When NOT to Use a Workflow
+
+- One-off tasks you will only do once
+- Tasks that need constant human judgment at every step
+
+---
+
+## Understanding Schemas (Zod)
+
+### What Schemas Do
+
+Schemas describe and validate the shape of data your workflow expects and produces. If someone sends the wrong data, the platform rejects it before your code runs. This prevents confusing errors deep inside your handler.
+
+The Elevasis SDK uses [Zod](https://zod.dev) for schema definition. Zod is a TypeScript-first validation library. Every workflow has an `inputSchema` and an `outputSchema`.
+
+### Common Zod Types
+
+| Zod Type | What It Means | Example |
+| --- | --- | --- |
+| `z.string()` | Text | `"hello"`, `"user@email.com"` |
+| `z.number()` | A number | `42`, `3.14` |
+| `z.boolean()` | True or false | `true`, `false` |
+| `z.array(z.string())` | A list of text values | `["a", "b", "c"]` |
+| `z.object({ name: z.string() })` | A group of named fields | `{ "name": "Jane" }` |
+| `z.string().optional()` | Text that might be missing | `"hello"` or not provided |
+| `z.enum(['a', 'b', 'c'])` | One of a specific set of values | `"a"` |
+| `z.string().email()` | Text that must be a valid email | `"user@example.com"` |
+
+### Why `z.infer` Exists
+
+`z.infer` creates a TypeScript type from a schema so the type system can check your code. You define the schema once and get both runtime validation and compile-time checking. Without it, you would have to define the same shape twice -- once as a Zod schema and once as a TypeScript type.
+
+```ts
+const myInput = z.object({ name: z.string(), age: z.number() });
+type MyInput = z.infer<typeof myInput>;
+// MyInput is now: { name: string; age: number }
+```
+
+### Common Schema Mistakes
+
+- Forgetting `.optional()` on fields that might be missing -- the platform will reject valid input that omits those fields
+- Returning data from a handler that does not match the output schema -- causes `outputSchema validation failed`
+- Misspelling field names -- the schema says `companyName`, but the handler returns `company_name`
+
+---
+
+## The Execution Model
+
+### What Happens When You Run a Workflow
+
+1. A request arrives at the Elevasis platform (someone runs `elevasis exec` or a schedule triggers)
+2. The platform creates a temporary server just for this execution
+3. Your code runs on that server
+4. The result is sent back
+5. The temporary server is deleted
+
+### Practical Implications
+
+| What You Might Expect | What Actually Happens | Why |
+| --- | --- | --- |
+| Files I create persist | Files disappear after execution | The server is temporary |
+| I can see logs in real-time | Logs appear after execution completes | No streaming from workers |
+| My code runs on my computer | Your code runs on Elevasis servers | That is what "deploy" means |
+| I can use unlimited memory | 256MB memory limit per execution | Prevents runaway processes |
+| Executions share state | Each execution is independent | No shared memory between runs |
+| I can call external APIs | Yes, outbound network is unrestricted | Workers have internet access |
+
+### What "completed" vs "failed" Means
+
+- **completed** -- Your code ran successfully and returned output
+- **failed** -- Something went wrong: your code threw an error, timed out (300s default), or ran out of memory
+
+---
+
+## Platform Tools Overview
+
+Platform tools are pre-built integrations the platform provides. You call them from inside workflow steps using `platform.call()` without managing API keys in your code.
+
+### Tool Categories
+
+| Category | Tools | Example Use |
+| --- | --- | --- |
+| Communication | Gmail, Resend, email | Send transactional emails, notifications |
+| CRM | Attio (11 methods) | Create leads, update records, search contacts |
+| Documents | PDF, Google Sheets, Notion | Generate invoices, read spreadsheets, update pages |
+| AI | LLM (GPT, Gemini, Claude) | Classify text, extract data, generate content |
+| Storage | Dropbox, platform storage | Upload files, create signed URLs |
+| Scheduling | Scheduler | Run workflows on a schedule or after a delay |
+| Approvals | Approval gates | Pause workflow until a human approves |
+| Verification | Mailso | Verify email addresses |
+| E-Signatures | SignatureAPI | Create and manage document envelopes |
+| Marketing | Instantly | Send email campaigns |
+| Payments | Stripe | Create payment links, checkout sessions |
+| Automation | Apify | Run web scraping actors |
+
+### How Credentials Work
+
+1. Create a credential in the Elevasis platform (API key, OAuth token, etc.) via the command center UI
+2. Give it a name (e.g., `my-gmail`, `production-attio`)
+3. In your code, pass that name: `platform.call({ credential: 'my-gmail', ... })`
+4. The platform injects the actual API key at runtime -- it never appears in your code
+
+### What Happens When a Credential Name is Wrong
+
+You will see a `PlatformToolError` with the message "credential not found". Check for typos -- credential names are case-sensitive.
+
+---
+
+## Common Errors and Fixes
+
+| Error | What It Means | How to Fix |
+| --- | --- | --- |
+| `ELEVASIS_API_KEY not set` | Your `.env` file is missing the API key | Add `ELEVASIS_API_KEY=sk_...` to `.env` |
+| `Schema validation failed` | The input data does not match your Zod schema | Compare the error's field names to your schema definition. Check types (string vs number) and required vs optional fields. |
+| `Cannot find module '@elevasis/sdk'` | Dependencies are not installed | Run `pnpm install` |
+| `PlatformToolError: credential not found` | The credential name in your code does not match any stored credential | Check spelling and case. Verify the credential name in the command center UI. |
+| `Execution timeout (300s)` | Your workflow took too long | Optimize your handler or break it into smaller steps. Check for infinite loops. |
+| `Cannot find name 'z'` | Missing Zod import | Add `import { z } from 'zod'` at the top of your file |
+| `Type 'X' is not assignable to type 'Y'` | Your handler returns data that does not match the output schema | Compare what your handler returns to what `outputSchema` expects. Field names and types must match exactly. |
+| `outputSchema validation failed` | Handler returned data but it does not match the output schema | Check field names, types, and required fields against your output schema. |
+| `Duplicate resource ID` | Two resources have the same `resourceId` | Each resource needs a unique ID within your organization. Rename one. |
+| `NODE_ENV=development` in .env | SDK is trying to connect to a local API server | Remove `NODE_ENV` from your `.env` file. The SDK connects to the hosted platform by default. |
+
+---
+
+## Design Decisions Guide
+
+### Single-Step vs Multi-Step
+
+Use a single step when the workflow does one thing -- validate an email, format a message, call one API.
+
+Use multiple steps when you have distinct phases (fetch data, process it, send a notification) or when you want separate error handling per phase. Each step failure is logged independently, making it easier to identify where something went wrong.
+
+### dev vs production Status
+
+- **dev** -- Resource is visible in the dashboard and can be triggered manually, but will not auto-trigger from schedules or webhooks. Use while building and testing.
+- **production** -- Resource is fully live. All trigger sources work. Use when you are confident it works correctly.
+
+You can switch between them by changing `status` in the workflow config and redeploying.
+
+### When to Use Conditional Routing
+
+Use `StepType.CONDITIONAL` when different inputs should follow different processing paths.
+
+Example: score >= 80 goes to the approve path, score >= 50 goes to the review path, everything else goes to the reject path. Each path can have its own steps and logic.
+
+Always include a `defaultTarget` fallback for inputs that do not match any condition. Without a fallback, an unmatched execution will fail.
+
+### When to Use Platform Tools vs Custom Code
+
+Use platform tools when the integration exists in the tool catalog -- they handle auth, retries, and error normalization for you.
+
+Write custom code (e.g., using `fetch` directly) only when you need a service or API method that is not in the catalog, or when you need fine-grained control over the HTTP request.
+
+---
+
+**Last Updated:** 2026-02-26