create-effector

中文文档 →

---

Scaffold a new Effector project in 30 seconds. Zero dependencies.

npx create-effector my-skill --type skill

What It Does

Generates the correct project structure for any Effector type — manifest, entry files, CI, README, LICENSE — so you can start building immediately instead of copying boilerplate.

Quick Start

Interactive Mode

npx create-effector

Walks you through name, type, runtime, and directory selection.

Direct Mode

npx create-effector <name> --type <type> [--runtime <runtime>]

Examples

# Skill — SKILL.md instructions for a CLI tool
npx create-effector github-pr-review --type skill

# Extension — TypeScript plugin for the runtime SDK
npx create-effector telegram-bot --type extension

# Workflow — Lobster pipeline chaining skills
npx create-effector deploy-pipeline --type workflow

# Workspace — Agent persona bundle (SOUL.md, AGENTS.md, etc.)
npx create-effector devops-agent --type workspace

# Bridge — Cross-runtime adapter (e.g., OpenClaw → MCP)
npx create-effector openclaw-langchain --type bridge

# Prompt — Reusable prompt template with variables
npx create-effector review-template --type prompt

Generated Structure

Each type generates a different structure tailored to its use case:

Skill

my-skill/
├── effector.toml      # Effector manifest
├── SKILL.md           # Skill instructions (entry file)
├── README.md
├── LICENSE
├── CHANGELOG.md
├── .gitignore
└── .github/workflows/ci.yml

Extension

my-extension/
├── effector.toml
├── src/index.ts       # Plugin entry (register function)
├── package.json       # npm package
├── tsconfig.json
├── README.md
├── LICENSE
├── CHANGELOG.md
├── .gitignore
└── .github/workflows/ci.yml

Workflow

my-workflow/
├── effector.toml
├── pipeline.yml       # Lobster pipeline definition
├── README.md
├── LICENSE
├── CHANGELOG.md
├── .gitignore
└── .github/workflows/ci.yml

Workspace

my-workspace/
├── effector.toml
├── SOUL.md            # Agent personality
├── AGENTS.md          # Capabilities and expertise
├── TOOLS.md           # Available tools
├── IDENTITY.md        # Name, role, branding
├── HEARTBEAT.md       # Health monitoring
├── README.md
├── LICENSE
├── CHANGELOG.md
├── .gitignore
└── .github/workflows/ci.yml

Bridge

my-bridge/
├── effector.toml
├── src/adapter.js     # Bridge adapter
├── package.json
├── README.md
├── LICENSE
├── CHANGELOG.md
├── .gitignore
└── .github/workflows/ci.yml

Prompt

my-prompt/
├── effector.toml
├── prompt.md          # Prompt template with variables
├── README.md
├── LICENSE
├── CHANGELOG.md
├── .gitignore
└── .github/workflows/ci.yml

Options

Option	Short	Default	Description
--type	-t	—	Effector type (required in direct mode)
--runtime	-r	openclaw	Primary runtime: openclaw, mcp, claude-agent-sdk, generic
--dir	-d	./<name>	Output directory
--no-git	—	false	Skip git initialization
--help	-h	—	Show help
--version	-v	—	Show version

How It Works

1. Parses arguments (or runs interactive prompts)
2. Generates effector.toml manifest with type-appropriate defaults
3. Generates entry files specific to the Effector type
4. Generates common files (LICENSE, CHANGELOG, .gitignore, CI)
5. Initializes a git repository

No network requests. No dependencies to install. Everything runs with Node.js built-ins.

Contributing

PRs welcome! See CONTRIBUTING.md.

License

MIT © 2026 effectorHQ Contributors