Skip to main content

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

Project description

DolphinDB Agent Skills

简体中文 | English

Offline DolphinDB knowledge skills for AI coding agents (Claude Code, Cursor, Trae, 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 / …)
  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

📂 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.0.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.0-py3-none-any.whl (6.4 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dolphindb_agent_skills-0.2.0.tar.gz
Algorithm Hash digest
SHA256 2383041efb4e6b306e10462e2bd21987b4c3a16599cf5729be7a31587051b5bc
MD5 f887aa7967f5374f1da16bf7e18ea3dc
BLAKE2b-256 db23dd19ff341990da7979bfc991547a6012214a5a311f91f6df67ece82501a8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for dolphindb_agent_skills-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9f0907246eb0be9ebd9d345315fe1d49b1ac98f1b91f7441cb6753b0afc54751
MD5 7cbb4c4af6c4f8a40ae6e17ab7c5f369
BLAKE2b-256 292a5a19f9f204d84fa4d426e719775fe2872ca6e36759d67e403a9d97ee369f

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