Skip to content

README.md

Latest commit

 

History

History
125 lines (90 loc) · 4.69 KB

README.md

File metadata and controls

125 lines (90 loc) · 4.69 KB

English | 简体中文

EasyEDA API Skill

An EasyEDA Pro API skill package for AI coding tools such as Claude Code, OpenCode, QwenCode, and any other tool that supports the Agent Skills standard.

This skill supports both online debugging of EasyEDA Pro through AI and extension development for EasyEDA Pro. When developing EasyEDA extensions, AI can use the extension-development documentation, API references, type information, usage examples, and bridge debugging capabilities provided by this skill to help with API lookup, code generation, and integration debugging. If you want to analyze or modify EasyEDA document source files directly instead of operating through the API, this project also provides documentation for the source file formats.

  • 📚 Structured API documentation — Automatically builds hierarchical indexes from reference docs for fast AI lookup
  • 🧾 Document source format specifications — Explains project, schematic, and PCB source formats for direct source analysis and modification
  • 🔌 WebSocket Bridge — A Node.js server that bridges AI tools and the EasyEDA client
  • 🤖 SKILL.md — A complete skill instruction file

Quick Start

1. Install dependencies

npm install

2. Build API documentation

npm run build:docs

This reads the raw API documentation from the reference/ directory and generates structured docs into the docs/ directory.

3. Start the WebSocket Bridge server

npm run server

The server automatically chooses an available port in the 49620-49629 range and waits for the EasyEDA client to connect.

4. Connect from EasyEDA

Install the run-api-gateway.eext extension in EasyEDA. Download:

After the extension is loaded, it connects to the Bridge server automatically by scanning the port range and verifying the handshake.

5. Use from an AI coding tool

AI coding tools such as Claude Code, OpenCode, and QwenCode automatically read SKILL.md for instructions, then use the HTTP API to send code to EasyEDA:

# Check EasyEDA connection status (assuming the service is on port 49620)
curl http://localhost:49620/health

# Execute EasyEDA code
curl -X POST http://localhost:49620/execute \
  -H "Content-Type: application/json" \
  -d '{"code": "return await eda.dmt_Project.getCurrentProjectInfo();"}'

One-Command Packaging

npm run pack

This performs the following steps:

  1. Build API documentation (docs/)
  2. Package SKILL.md, documentation, and the server into dist/easyeda-api/
  3. Generate dist/easyeda-api.zip for upload

If the documentation has already been built, you can skip that step:

npm run pack:fast

Publish to ClawHub

npx clawhub@latest publish dist/easyeda-api/

Or upload the zip file at https://clawhub.ai/upload

Architecture

┌──────────────┐   HTTP/WS     ┌────────────────┐   WebSocket    ┌──────────┐
│   AI Agent   │ ◄───────────► │ Bridge Server  │ ◄───────────► │  EasyEDA │
│ (Skill Tool) │  Port Range   │   (Node.js)    │  Port Range   │ (Client) │
└──────────────┘  49620-49629   └────────────────┘  49620-49629   └──────────┘

Communication Protocol

Message Type Direction Description
execute AI → EDA Execute JavaScript code
result EDA → AI Return execution result
error EDA → AI Return execution error
handshake Server → Client Connection verification (includes service: "easyeda-bridge")
ping/pong Bidirectional Heartbeat

Directory Structure

easyeda-api-skill/
  SKILL.md              # AgentSkills standard skill definition
  AGENTS.md             # Agent prompt guide
  package.json          # Project configuration
  reference/            # Raw API reference docs (gitignored)
  docs/                 # Built structured docs (gitignored)
  format/               # EasyEDA document source format specs (project/schematic/pcb)
  guide/                # API development guides
  user-guide/           # User guides
  server/index.mjs      # WebSocket Bridge server
  scripts/
    build-docs.mjs      # Documentation build script
    pack.mjs            # Packaging script
  dist/                 # Packaging output (gitignored)
    easyeda-api/        # Publishable skill directory
    easyeda-api.zip     # Zip archive for ClawHub upload