Skip to content

Add npx install option for QuestDB agent skill #423

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
javier merged 1 commit into from
Apr 22, 2026
Merged

Add npx install option for QuestDB agent skill #423

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions documentation/getting-started/ai-coding-agents.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ description:
Use AI coding agents like Claude Code or OpenAI Codex to build applications, write queries, and work with QuestDB using natural language.
---

import Tabs from "@theme/Tabs";

import TabItem from "@theme/TabItem";

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.

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.
Expand Down Expand Up @@ -50,6 +54,23 @@ The <a href="https://github.com/questdb/questdb-agent-skill" target="_blank">Que

### Installation

<Tabs defaultValue="npx" values={[
{ label: "npx (recommended)", value: "npx" },
{ label: "Manual copy", value: "manual" },
]}>

<TabItem value="npx">

```shell
npx skills add questdb/questdb-agent-skill
```

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.

</TabItem>

<TabItem value="manual">

Copy the `questdb/` folder from the <a href="https://github.com/questdb/questdb-agent-skill" target="_blank">repository</a> into your skills directory:

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

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

</TabItem>

</Tabs>

### What's included

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