Skip to content

Commit ccf2c5d

Browse files
authored
Add npx install option for QuestDB agent skill (#423)
## Summary - Add tabbed installation section for the QuestDB agent skill showing both `npx skills add` and manual copy methods
1 parent eb3df81 commit ccf2c5d

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

documentation/getting-started/ai-coding-agents.mdx

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ description:
55
Use AI coding agents like Claude Code or OpenAI Codex to build applications, write queries, and work with QuestDB using natural language.
66
---
77

8+
import Tabs from "@theme/Tabs";
9+
10+
import TabItem from "@theme/TabItem";
11+
812
AI coding agents like <a href="https://claude.ai/code" target="_blank">Claude Code</a> and <a href="https://openai.com/index/openai-codex/" target="_blank">OpenAI Codex</a> can help you build applications that use QuestDB.
913

1014
These agents work with QuestDB out of the box by reading the online documentation. For deeper integration, agent skills embed rich context directly into the agent so it can work faster and more accurately. The [QuestDB agent skill](#questdb-agent-skill) covers SQL, ingestion, and Grafana dashboards, while the [TSBS Benchmark skill](#tsbs-benchmark-skill) automates end-to-end performance benchmarking.
@@ -50,6 +54,23 @@ The <a href="https://github.com/questdb/questdb-agent-skill" target="_blank">Que
5054

5155
### Installation
5256

57+
<Tabs defaultValue="npx" values={[
58+
{ label: "npx (recommended)", value: "npx" },
59+
{ label: "Manual copy", value: "manual" },
60+
]}>
61+
62+
<TabItem value="npx">
63+
64+
```shell
65+
npx skills add questdb/questdb-agent-skill
66+
```
67+
68+
This installs the skill globally for Claude Code. To install it for a specific project only, run the command from the project directory with the `--local` flag.
69+
70+
</TabItem>
71+
72+
<TabItem value="manual">
73+
5374
Copy the `questdb/` folder from the <a href="https://github.com/questdb/questdb-agent-skill" target="_blank">repository</a> into your skills directory:
5475

5576
**Claude Code:**
@@ -62,6 +83,10 @@ Copy the `questdb/` folder from the <a href="https://github.com/questdb/questdb-
6283

6384
The folder must contain `SKILL.md` and the `references/` directory.
6485

86+
</TabItem>
87+
88+
</Tabs>
89+
6590
### What's included
6691

6792
- **SQL reference** - QuestDB-specific syntax including `SAMPLE BY`, `LATEST ON`, `ASOF JOIN`, window functions, and materialized views

0 commit comments

Comments
 (0)