AgentSkillsCN

clay-local-dev-loop

配置Clay本地开发,支持热重载与测试。 在设置开发环境、配置测试工作流或建立快速迭代周期以使用Clay时使用。 通过“clay dev设置”、“clay本地开发”、“clay dev环境”、“develop with clay”等短语触发。

SKILL.md
--- frontmatter
name: clay-local-dev-loop
description: |
  Configure Clay local development with hot reload and testing.
  Use when setting up a development environment, configuring test workflows,
  or establishing a fast iteration cycle with Clay.
  Trigger with phrases like "clay dev setup", "clay local development",
  "clay dev environment", "develop with clay".
allowed-tools: Read, Write, Edit, Bash(npm:*), Bash(pnpm:*), Grep
version: 1.0.0
license: MIT
author: Jeremy Longshore <jeremy@intentsolutions.io>

Clay Local Dev Loop

Overview

Set up a fast, reproducible local development workflow for Clay.

Prerequisites

  • Completed clay-install-auth setup
  • Node.js 18+ with npm/pnpm
  • Code editor with TypeScript support
  • Git for version control

Instructions

Step 1: Create Project Structure

code
my-clay-project/
├── src/
│   ├── clay/
│   │   ├── client.ts       # Clay client wrapper
│   │   ├── config.ts       # Configuration management
│   │   └── utils.ts        # Helper functions
│   └── index.ts
├── tests/
│   └── clay.test.ts
├── .env.local              # Local secrets (git-ignored)
├── .env.example            # Template for team
└── package.json

Step 2: Configure Environment

bash
# Copy environment template
cp .env.example .env.local

# Install dependencies
npm install

# Start development server
npm run dev

Step 3: Setup Hot Reload

json
{
  "scripts": {
    "dev": "tsx watch src/index.ts",
    "test": "vitest",
    "test:watch": "vitest --watch"
  }
}

Step 4: Configure Testing

typescript
import { describe, it, expect, vi } from 'vitest';
import { ClayClient } from '../src/clay/client';

describe('Clay Client', () => {
  it('should initialize with API key', () => {
    const client = new ClayClient({ apiKey: 'test-key' });
    expect(client).toBeDefined();
  });
});

Output

  • Working development environment with hot reload
  • Configured test suite with mocking
  • Environment variable management
  • Fast iteration cycle for Clay development

Error Handling

ErrorCauseSolution
Module not foundMissing dependencyRun npm install
Port in useAnother processKill process or change port
Env not loadedMissing .env.localCopy from .env.example
Test timeoutSlow networkIncrease test timeout

Examples

Mock Clay Responses

typescript
vi.mock('@clay/sdk', () => ({
  ClayClient: vi.fn().mockImplementation(() => ({
    // Mock methods here
  })),
}));

Debug Mode

bash
# Enable verbose logging
DEBUG=CLAY=* npm run dev

Resources

Next Steps

See clay-sdk-patterns for production-ready code patterns.