Skip to main content

DolphinDB Agent Skills installer — install, configure and manage DolphinDB knowledge skills for AI coding agents (Claude Code, Cursor, Trae, GitHub Copilot, and more)

Project description

DolphinDB Agent Skills

English | 简体中文

DolphinDB skills for AI coding agents — install, configure, and manage offline DolphinDB knowledge skills for Claude Code, Cursor, Trae, GitHub Copilot, Hermes, and more. Teach your AI assistant to write correct DolphinDB scripts, SQL queries, and stream-processing code.


🧩 Overview

dolphindb-agent-skills bundles complete 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/tradercjz/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
pi (workspace) .pi/skills/ project
pi (global) ~/.pi/agent/skills/ global
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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dolphindb_agent_skills-0.2.4.tar.gz (4.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dolphindb_agent_skills-0.2.4-py3-none-any.whl (6.4 MB view details)

Uploaded Python 3

File details

Details for the file dolphindb_agent_skills-0.2.4.tar.gz.

File metadata

  • Download URL: dolphindb_agent_skills-0.2.4.tar.gz
  • Upload date:
  • Size: 4.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.21

File hashes

Hashes for dolphindb_agent_skills-0.2.4.tar.gz
Algorithm Hash digest
SHA256 cfdb977b29993c1b9c2022515df302b8d83fa9f57c014e2d0df532d53877b580
MD5 0b720e8d4b101ed7668f5d47709f18a8
BLAKE2b-256 5da38cc2d73f507d1f131ebe4532b220ed440b33da7b6add665a18586c802c7e

See more details on using hashes here.

File details

Details for the file dolphindb_agent_skills-0.2.4-py3-none-any.whl.

File metadata

File hashes

Hashes for dolphindb_agent_skills-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 109a06160b1d42d2d20974c29d7cc699435caef31d7f80371d42653f2eae81a8
MD5 ed1ae5f9116a9101dc18e6de1f0b662e
BLAKE2b-256 aeacecfe663fb280f7eb54134d3fd65541727cf004bc8ad3f6856608e25b7c76

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page