Skip to content

Commit 72dab9b

Browse files
cevianclaude
andcommitted
rename "crayon" imports to "runcrayon" in skills and docs
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 6e5cb33 commit 72dab9b

12 files changed

+32
-32
lines changed

docs/plans/2026-01-23-crayon-design.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ crayon/
8585
**Core SDK API (plain TypeScript functions, no framework dependencies):**
8686

8787
```typescript
88-
import { createCrayon } from 'crayon';
88+
import { createCrayon } from 'runcrayon';
8989

9090
// Create instance at app startup (configures DBOS, discovers workflows)
9191
const crayon = await createCrayon({ workflowDir: './generated/workflows' });
@@ -260,7 +260,7 @@ The runtime executes compiled TypeScript workflows using DBOS for durability.
260260
**SDK surface (intentionally minimal):**
261261

262262
```typescript
263-
import { Workflow, WorkflowContext } from 'crayon';
263+
import { Workflow, WorkflowContext } from 'runcrayon';
264264

265265
export const icpScoring = Workflow.create({
266266
name: 'icp-scoring',

docs/plans/2026-01-23-outreach-automation-example.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -598,7 +598,7 @@ Given company research and social proof, create a compelling email sequence.
598598
### `src/tools/browser/navigate.ts`
599599

600600
```typescript
601-
import { ToolDefinition } from 'crayon';
601+
import { ToolDefinition } from 'runcrayon';
602602
import { getBrowser } from '../lib/browser-factory';
603603

604604
export const navigate: ToolDefinition = {
@@ -622,7 +622,7 @@ export const navigate: ToolDefinition = {
622622
### `src/tools/browser/click.ts`
623623

624624
```typescript
625-
import { ToolDefinition } from 'crayon';
625+
import { ToolDefinition } from 'runcrayon';
626626
import { getBrowser } from '../lib/browser-factory';
627627

628628
export const click: ToolDefinition = {
@@ -646,7 +646,7 @@ export const click: ToolDefinition = {
646646
### `src/tools/browser/getText.ts`
647647

648648
```typescript
649-
import { ToolDefinition } from 'crayon';
649+
import { ToolDefinition } from 'runcrayon';
650650
import { getBrowser } from '../lib/browser-factory';
651651

652652
export const getText: ToolDefinition = {
@@ -674,7 +674,7 @@ export const getText: ToolDefinition = {
674674
### `src/tools/embeddings/similaritySearch.ts`
675675

676676
```typescript
677-
import { ToolDefinition } from 'crayon';
677+
import { ToolDefinition } from 'runcrayon';
678678
import { db } from '../lib/db';
679679

680680
export const similaritySearch: ToolDefinition = {
@@ -710,7 +710,7 @@ For steps that don't need agentic behavior, we use function nodes.
710710
### `src/nodes/find-similar-customers.ts`
711711

712712
```typescript
713-
import { NodeDefinition } from 'crayon';
713+
import { NodeDefinition } from 'runcrayon';
714714
import { generateEmbedding } from '../tools/embeddings/generate';
715715
import { db } from '../lib/db';
716716

@@ -748,7 +748,7 @@ export const findSimilarCustomers: NodeDefinition<FindSimilarInput> = {
748748
### `src/nodes/download-transcripts.ts`
749749

750750
```typescript
751-
import { NodeDefinition } from 'crayon';
751+
import { NodeDefinition } from 'runcrayon';
752752
import { S3Client, ListObjectsV2Command, GetObjectCommand } from '@aws-sdk/client-s3';
753753
import { writeFile, mkdir } from 'fs/promises';
754754
import { join } from 'path';
@@ -803,7 +803,7 @@ The compiler generates TypeScript from specs. Example for company-research:
803803
### `generated/workflows/company-research.ts`
804804

805805
```typescript
806-
import { Workflow, WorkflowContext } from 'crayon';
806+
import { Workflow, WorkflowContext } from 'runcrayon';
807807

808808
interface CompanyResearchInputs {
809809
company_name: string;

docs/plans/2026-01-23-phase1-project-scaffolding.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -569,7 +569,7 @@ Invoke this skill when:
569569
Generated workflows follow this structure:
570570

571571
```typescript
572-
import { Workflow, WorkflowContext } from 'crayon';
572+
import { Workflow, WorkflowContext } from 'runcrayon';
573573

574574
interface <Name>Inputs {
575575
// ... from ## Inputs section
@@ -1008,7 +1008,7 @@ export const checkRouter = createTRPCRouter({
10081008
This initializes the crayon instance for the app.
10091009

10101010
```typescript
1011-
import { createCrayon } from "crayon";
1011+
import { createCrayon } from "runcrayon";
10121012

10131013
// Initialize crayon with workflow directory
10141014
export const crayon = await createCrayon({
@@ -1239,7 +1239,7 @@ Make an HTTP HEAD request to the URL and capture the response.
12391239
This is the function node referenced by the workflow.
12401240

12411241
```typescript
1242-
import type { NodeDefinition } from "crayon";
1242+
import type { NodeDefinition } from "runcrayon";
12431243

12441244
interface HttpHeadInput {
12451245
url: string;

docs/plans/2026-01-26-phase2-sdk-core-design.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Phase 2 implements the core crayon SDK that discovers, registers, and executes w
2424
### Initialization
2525

2626
```typescript
27-
import { createCrayon } from 'crayon';
27+
import { createCrayon } from 'runcrayon';
2828
import { workflows } from '@/generated/workflows';
2929
import { agents } from '@/generated/agents';
3030
import { nodes } from '@/nodes';
@@ -49,7 +49,7 @@ crayon.triggerWorkflow(name, inputs) // Executes by name (webhooks/UI)
4949

5050
```typescript
5151
import { z } from 'zod';
52-
import { Workflow } from 'crayon';
52+
import { Workflow } from 'runcrayon';
5353

5454
export const icpScoring = Workflow.create({
5555
name: 'icp-scoring',

docs/plans/2026-01-27-cli-implementation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ Expected: FAIL with "Cannot find module '../discovery.js'"
252252
import fs from "fs";
253253
import path from "path";
254254
import { createJiti } from "jiti";
255-
import type { Executable } from "crayon";
255+
import type { Executable } from "runcrayon";
256256

257257
// eslint-disable-next-line @typescript-eslint/no-explicit-any
258258
type WorkflowExecutable = Executable<any, any>;
@@ -609,7 +609,7 @@ git commit -m "feat(cli): implement list command"
609609
**Step 1: Add run command after list command**
610610

611611
```typescript
612-
import { createCrayon } from "crayon";
612+
import { createCrayon } from "runcrayon";
613613
import { resolveEnv } from "./env.js";
614614

615615
program

docs/plans/2026-01-27-compile-workflow-design.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,8 +116,8 @@ Generated `url-summarizer.ts`:
116116
```typescript
117117
// generated/workflows/url-summarizer.ts
118118
import { z } from "zod";
119-
import { Workflow } from "crayon";
120-
import { webRead } from "crayon";
119+
import { Workflow } from "runcrayon";
120+
import { webRead } from "runcrayon";
121121
import { pageSummarizer } from "../../specs/agents/page-summarizer.js";
122122

123123
// Input schema

docs/plans/2026-01-27-phase5-implementation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -613,7 +613,7 @@ Generate TypeScript file at `generated/workflows/<name>.ts`.
613613
// generated/workflows/<name>.ts
614614
// Auto-generated by compile-workflow skill - do not edit directly
615615
import { z } from "zod";
616-
import { Workflow } from "crayon";
616+
import { Workflow } from "runcrayon";
617617
// ... node/tool imports ...
618618

619619
// Input schema
@@ -815,7 +815,7 @@ Create `examples/uptime-app/src/nodes/http-head.ts`:
815815

816816
```typescript
817817
import { z } from "zod";
818-
import { Node } from "crayon";
818+
import { Node } from "runcrayon";
819819

820820
export const httpHead = Node.create({
821821
name: "http-head",

skills/compile-workflow/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ For each task's `**Node:**` reference, determine what it is and where it lives.
9191

9292
| Type | Location | Import Pattern |
9393
|------|----------|----------------|
94-
| `(builtin)` | Built-in nodes from crayon | `import { webRead } from "crayon"` |
94+
| `(builtin)` | Built-in nodes from crayon | `import { webRead } from "runcrayon"` |
9595
| `(node)` | User-defined in `src/nodes/` or `nodes/` | `import { nodeName } from "../../src/nodes/<name>"` |
9696
| `(agent)` | `agents/<name>.ts` | `import { agentName } from "../../agents/<name>"` |
9797

@@ -105,7 +105,7 @@ For each task's `**Node:**` reference, determine what it is and where it lives.
105105

106106
2. **For builtin nodes:**
107107
- Check if it's a built-in node (`web_read`, etc.)
108-
- Import from `"crayon"`
108+
- Import from `"runcrayon"`
109109

110110
3. **For user-defined nodes:**
111111
- Look for `src/nodes/<name>.ts`
@@ -123,7 +123,7 @@ When an agent's description contains a `**Tools needed:**` section (added by `/c
123123

124124
| Tool Type | Import Pattern | tools record entry |
125125
|-----------|----------------|--------------------|
126-
| `(builtin)` | `import { webRead } from "crayon"` | `web_read: webRead` |
126+
| `(builtin)` | `import { webRead } from "runcrayon"` | `web_read: webRead` |
127127
| `(provider)` | `import { createOpenAI } from "@ai-sdk/openai"; const openai = createOpenAI();` | `web_search: openai.tools.webSearch()` |
128128
| `(user node in src/nodes/<file>.ts)` | `import { name } from "../../src/nodes/<file>"` | `enrich_company: enrichCompany` |
129129

skills/create-workflow/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ This phase focuses on **WHAT** each node does, not **HOW**. Capture purpose and
7373
// generated/workflows/<name>.ts
7474
// Auto-generated by create-workflow skill
7575
import { z } from "zod";
76-
import { Workflow } from "crayon";
76+
import { Workflow } from "runcrayon";
7777
// ... node/agent imports (NEVER use .js extensions — use extensionless imports) ...
7878

7979
const <Name>InputSchema = z.object({
@@ -160,7 +160,7 @@ For each task in the workflow, create a stub file:
160160
```typescript
161161
// src/nodes/<name>.ts
162162
import { z } from "zod";
163-
import { Node } from "crayon";
163+
import { Node } from "runcrayon";
164164

165165
export const <camelCaseName> = Node.create({
166166
name: "<kebab-case-name>",
@@ -185,7 +185,7 @@ export const <camelCaseName> = Node.create({
185185
```typescript
186186
// agents/<name>.ts
187187
import { z } from "zod";
188-
import { Agent } from "crayon";
188+
import { Agent } from "runcrayon";
189189
import { fileURLToPath } from "url";
190190
import path from "path";
191191

skills/integrations/postgres.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,7 @@ All `${value}` expressions use postgres.js tagged template literals, which autom
191191
```typescript
192192
// src/nodes/postgres-get-<table>.ts
193193
import { z } from "zod";
194-
import { Node } from "crayon";
194+
import { Node } from "runcrayon";
195195
import { getPostgresClient } from "../integrations/postgres/client.js";
196196

197197
export const postgresGet<Table> = Node.create({
@@ -230,7 +230,7 @@ export const postgresGet<Table> = Node.create({
230230
```typescript
231231
// src/nodes/postgres-list-<table>.ts
232232
import { z } from "zod";
233-
import { Node } from "crayon";
233+
import { Node } from "runcrayon";
234234
import { getPostgresClient } from "../integrations/postgres/client.js";
235235

236236
export const postgresList<Table> = Node.create({
@@ -282,7 +282,7 @@ export const postgresList<Table> = Node.create({
282282
```typescript
283283
// src/nodes/postgres-create-<table>.ts
284284
import { z } from "zod";
285-
import { Node } from "crayon";
285+
import { Node } from "runcrayon";
286286
import { getPostgresClient } from "../integrations/postgres/client.js";
287287

288288
export const postgresCreate<Table> = Node.create({

0 commit comments

Comments
 (0)