@butlerw/vellum 0.1.0

package/src/commands/init/templates/example-workflow.md

@@ -0,0 +1,101 @@
+---
+name: bugfix
+description: Structured workflow for fixing bugs
+version: "1.0.0"
+phases:
+  - name: reproduce
+    description: Reproduce and understand the bug
+  - name: diagnose
+    description: Find the root cause
+  - name: fix
+    description: Implement the fix
+  - name: verify
+    description: Verify the fix works
+---
+
+# Bugfix Workflow
+
+A structured approach to fixing bugs safely and effectively.
+
+## Phase 1: Reproduce
+
+**Goal**: Understand and reliably reproduce the bug.
+
+### Steps
+
+1. Read the bug report/description carefully
+2. Identify the expected vs actual behavior
+3. Find or create a minimal reproduction case
+4. Document reproduction steps
+
+### Checklist
+
+- [ ] Can reproduce the bug consistently
+- [ ] Understand what behavior is expected
+- [ ] Have a clear test case
+
+## Phase 2: Diagnose
+
+**Goal**: Find the root cause of the bug.
+
+### Steps
+
+1. Add logging/debugging to trace execution
+2. Review recent changes to affected code
+3. Check for similar issues in history
+4. Identify the exact line(s) causing the issue
+
+### Questions to Answer
+
+- When was this introduced?
+- What code path leads to the bug?
+- Are there related issues?
+
+### Checklist
+
+- [ ] Root cause identified
+- [ ] Understand why the bug occurs
+- [ ] Know the scope of impact
+
+## Phase 3: Fix
+
+**Goal**: Implement a safe, minimal fix.
+
+### Principles
+
+1. **Minimal**: Change only what's necessary
+2. **Safe**: Don't introduce new bugs
+3. **Clear**: Make the fix easy to understand
+4. **Tested**: Add regression test
+
+### Steps
+
+1. Write a failing test that reproduces the bug
+2. Implement the fix
+3. Verify the test passes
+4. Review for side effects
+
+### Checklist
+
+- [ ] Test written first
+- [ ] Fix implemented
+- [ ] All tests pass
+- [ ] No new warnings
+
+## Phase 4: Verify
+
+**Goal**: Confirm the fix works and doesn't break anything.
+
+### Steps
+
+1. Run the full test suite
+2. Manually verify the original reproduction case
+3. Check edge cases
+4. Review the diff one more time
+
+### Final Checklist
+
+- [ ] Original bug is fixed
+- [ ] No regressions introduced
+- [ ] Tests pass
+- [ ] Ready for review

package/src/commands/init/templates/prompts-readme.md

@@ -0,0 +1,52 @@
+# Prompts Directory
+
+Custom prompt files for Vellum. Place your `.md` files here to extend or override built-in prompts.
+
+## Structure
+
+```text
+prompts/
+├── roles/          # Role definitions (e.g., coder, architect)
+├── providers/      # Provider-specific prompts
+├── spec/           # Spec workflow phases
+├── workers/        # Worker agent prompts
+└── custom/         # Custom prompts
+```
+
+## File Format
+
+Each prompt file uses YAML frontmatter:
+
+```markdown
+---
+id: my-prompt
+name: My Custom Prompt
+category: custom
+description: A brief description
+version: "1.0.0"
+---
+
+Your prompt content here.
+
+## Variables
+
+Use `{{variable}}` syntax for interpolation:
+- `{{os}}` - Operating system
+- `{{shell}}` - Default shell
+- `{{cwd}}` - Current directory
+- `{{date}}` - Current date
+- `{{mode}}` - Current coding mode
+- `{{provider}}` - LLM provider
+- `{{model}}` - Model name
+```
+
+## Priority
+
+Prompts in this directory take precedence over:
+1. User prompts (`~/.vellum/prompts/`)
+2. Legacy paths (`.github/prompts/`, `.claude/prompts/`, etc.)
+3. Built-in prompts
+
+## Documentation
+
+See [Vellum Prompts Documentation](https://vellum.dev/docs/prompts) for more details.

package/src/commands/init/templates/rules-readme.md

@@ -0,0 +1,63 @@
+# Rules Directory
+
+Global rules that apply to all Vellum sessions. Rules are always included in the system prompt.
+
+## Structure
+
+```text
+rules/
+├── *.md               # Global rules (all modes)
+└── rules-{mode}/      # Mode-specific rules
+    └── *.md
+```
+
+## Mode-Specific Rules
+
+Create subdirectories for mode-specific rules:
+
+```text
+rules/
+├── coding-standards.md       # All modes
+├── rules-vibe/
+│   └── fast-iteration.md     # Vibe mode only
+├── rules-plan/
+│   └── documentation.md      # Plan mode only
+└── rules-spec/
+    └── formal-review.md      # Spec mode only
+```
+
+## File Format
+
+Rules use simple markdown:
+
+```markdown
+---
+id: no-console-log
+name: No Console Logs
+priority: 100
+enabled: true
+---
+
+## Rule: No Console Logs in Production
+
+Never leave `console.log()` statements in production code.
+
+### Instead
+
+- Use a logging library like `pino` or `winston`
+- Remove debug logs before committing
+- Use conditional logging for development
+```
+
+## Frontmatter Options
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `id` | string | Unique identifier (required) |
+| `name` | string | Display name |
+| `priority` | number | Load order (lower = first) |
+| `enabled` | boolean | Whether rule is active |
+
+## Documentation
+
+See [Vellum Rules Documentation](https://vellum.dev/docs/rules) for more details.

package/src/commands/init/templates/skills-readme.md

@@ -0,0 +1,83 @@
+# Skills Directory
+
+Skills are reusable prompt modules with specialized knowledge. They can be activated on-demand or automatically based on context.
+
+## Structure
+
+```text
+skills/
+├── {skill-name}/
+│   ├── SKILL.md           # Main skill definition (required)
+│   ├── scripts/           # Helper scripts (optional)
+│   ├── references/        # Reference documents (optional)
+│   └── assets/            # Additional assets (optional)
+└── README.md
+```
+
+## SKILL.md Format
+
+```markdown
+---
+name: typescript-testing
+description: Expert knowledge for testing TypeScript applications
+version: "1.0.0"
+triggers:
+  - "test"
+  - "testing"
+  - "vitest"
+  - "jest"
+tags:
+  - typescript
+  - testing
+  - vitest
+---
+
+# TypeScript Testing Skill
+
+## Overview
+
+This skill provides expert guidance for testing TypeScript applications.
+
+## Best Practices
+
+1. Use `vitest` for unit tests
+2. Follow the AAA pattern (Arrange, Act, Assert)
+3. Mock external dependencies
+
+## Examples
+
+### Basic Test
+
+\`\`\`typescript
+import { describe, it, expect } from 'vitest';
+
+describe('MyFunction', () => {
+  it('should return expected value', () => {
+    const result = myFunction();
+    expect(result).toBe(expected);
+  });
+});
+\`\`\`
+```
+
+## Frontmatter Options
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `name` | string | Skill identifier (required) |
+| `description` | string | Brief description (required) |
+| `version` | string | Semantic version |
+| `triggers` | string[] | Keywords that activate this skill |
+| `tags` | string[] | Categorization tags |
+| `priority` | number | Load order when multiple skills match |
+
+## Activation
+
+Skills can be:
+- **Auto-activated**: When trigger keywords are detected
+- **Manual**: Via `/skill {name}` command
+- **Context-aware**: Based on file types or project structure
+
+## Documentation
+
+See [Vellum Skills Documentation](https://vellum.dev/docs/skills) for more details.

package/src/commands/init/templates/workflows-readme.md

@@ -0,0 +1,94 @@
+# Workflows Directory
+
+Multi-step workflows for complex tasks. Workflows define a sequence of phases that guide the AI through structured processes.
+
+## Structure
+
+```text
+workflows/
+├── {workflow-name}.md    # Workflow definition
+└── README.md
+```
+
+## File Format
+
+```markdown
+---
+name: feature
+description: Implement a new feature with full lifecycle
+version: "1.0.0"
+phases:
+  - name: research
+    description: Understand requirements
+  - name: design
+    description: Create implementation plan
+  - name: implement
+    description: Write the code
+  - name: test
+    description: Add tests
+  - name: document
+    description: Update documentation
+---
+
+# Feature Workflow
+
+Structured workflow for implementing new features.
+
+## Phase 1: Research
+
+- Understand the feature requirements
+- Identify affected components
+- List dependencies
+
+## Phase 2: Design
+
+- Create high-level design
+- Define interfaces
+- Plan file changes
+
+## Phase 3: Implement
+
+- Write implementation code
+- Follow coding standards
+- Keep changes minimal
+
+## Phase 4: Test
+
+- Add unit tests
+- Run existing tests
+- Fix any regressions
+
+## Phase 5: Document
+
+- Update README if needed
+- Add JSDoc comments
+- Update changelog
+```markdown
+
+## Frontmatter Options
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `name` | string | Workflow identifier (required) |
+| `description` | string | Brief description (required) |
+| `version` | string | Semantic version |
+| `phases` | array | Phase definitions |
+| `phases[].name` | string | Phase identifier |
+| `phases[].description` | string | Phase description |
+
+## Usage
+
+```bash
+# Start a workflow
+/workflow feature
+
+# View available workflows
+/workflow list
+
+# Get help
+/workflow help
+```
+
+## Documentation
+
+See [Vellum Workflows Documentation](https://vellum.dev/docs/workflows) for more details.