dolphindb-agent-skills 0.2.2

DolphinDB Agent Skills installer — install DolphinDB knowledge skills into your AI coding agent (Claude Code, Cursor, Trae, etc.)

DolphinDB Agent Skills

简体中文 | English

Offline DolphinDB knowledge skills for AI coding agents (Claude Code, Cursor, Trae, Hermes, and more).

---

🧩 Overview

This project bundles DolphinDB documentation as Agent Skills so your AI coding assistant can answer DolphinDB questions and write correct code — no internet required, no runtime dependencies.

Covers:

• DolphinDB scripting language syntax and built-in functions
• SQL queries, time-series analytics, stream computing
• Distributed table (DFS) design and best practices
• Python / Java / C++ API reference
• Data ingestion, performance tuning, and administration

---

📦 Included Skills

Skill	Description
dolphindb	Full offline DolphinDB knowledge base with high-frequency code snippets and API quick-reference

---

🚀 Quick Start

Option 1 — Install from PyPI (recommended)

pip install dolphindb-agent-skills
dolphindb-agent-skills

Windows / PATH issue? If your shell says dolphindb-agent-skills: command not found (or 'dolphindb-agent-skills' is not recognized on Windows) — this means pip installed the executable into a Scripts directory that is not on your PATH. Just run it as a Python module instead, which always works:

python -m dolphindb_skill_installer

Alternatively, install via pipx (it handles PATH automatically):

pipx install dolphindb-agent-skills

The interactive installer will ask you to:

1. Select your AI coding tool (Claude Code / Cursor / Trae / Hermes / …)
2. Confirm the install directory (project-level or global)
3. Pick skills and install with one confirmation

Option 2 — Manual install

git clone https://github.com/dolphindb/dolphindb-agent-skills.git

# Example: install into Claude Code
cp -r dolphindb-agent-skills/skills/dolphindb .claude/skills/

---

🛠️ Supported Tools

Tool	Skills directory	Scope
Claude Code	.claude/skills/	project
Cursor	.cursor/skills/	project
Trae	.trae/skills/	project
OpenCode	.opencode/skills/	project
GitHub Copilot	.github/skills/	project
Codex	.agents/skills/	project
OpenClaw	~/.openclaw/workspace/skills/	global
Qoder	.qoder/skills/	project
Antigravity (workspace)	.agent/skills/	project
Antigravity (global)	~/.agent/skills/	global
Hermes	~/.hermes/skills/database/	global

---

📂 Project Structure

dolphindb-agent-skills/
├── plugin.json                          # Claude Code marketplace metadata
├── pyproject.toml                       # Python package config
├── upload_to_pypi.py                    # Build & publish helper
├── skills/
│   └── dolphindb/
│       ├── SKILL.md                     # ★ Skill entry (trigger + doc index)
│       └── docs/                        # Offline documentation library
│           ├── 00.overview.md
│           ├── 01.quick-start.md
│           ├── 02.data-types.md
│           ├── ...
│           └── 14.admin.md
└── src/
    └── dolphindb_skill_installer/
        ├── __init__.py
        └── main.py                      # Interactive installer CLI

---

🔧 Contributing

Update documentation

Edit or add Markdown files in skills/dolphindb/docs/. Update the index table in SKILL.md accordingly.

Build and publish

# Requires uv (https://docs.astral.sh/uv/)
uv run upload_to_pypi.py           # build only
uv run upload_to_pypi.py --upload  # build + upload to PyPI

---

📄 License

Apache License 2.0

---

🔗 Links

• DolphinDB Documentation
• DolphinDB GitHub