convex-quickstart

---
name: convex-quickstart
description: "Use when scaffolding a real-time React/Next backend on Convex from zero — wires the project, auth, schema, and reactive queries via Convex's official agent skills."
source: https://github.com/get-convex/agent-skills
generated: 2026-05-17T04:18:18.377Z
category: platform
audience: engineers
---

## When to use

- Starting a new project that needs a reactive backend with queries, mutations, and actions
- Adding Convex to an existing React or Next.js app
- Wiring authentication into a Convex app
- Planning a safe schema migration on Convex data
- Auditing a Convex deployment for performance issues
- Building a reusable Convex component to share across projects

## Key concepts

### convex (router skill)

Main entry point that routes the agent to the right specialized skill based on the task. Invoking convex first lets the router pick between quickstart, auth setup, component creation, migration, or performance auditing instead of guessing.

### convex-quickstart

Skill focused on starting new projects or integrating Convex into an existing codebase. It handles the initial project layout, Convex client wiring, and the first query/mutation pair so the app is reactive end-to-end on first run.

### convex-setup-auth

Dedicated skill for authentication configuration on Convex. Separated from quickstart so auth can be added later without re-scaffolding, and so the agent does not blur the boundary between backend functions and auth providers.

### convex-migration-helper

Plans and executes data migrations safely — the skill is explicit about migrations being a hazardous workflow, so it walks through a plan before touching production data instead of running ad-hoc scripts.

### convex-performance-audit

Diagnoses performance issues in a Convex deployment: hot queries, oversized documents, chatty subscriptions, and pagination smells. Run this skill instead of asking generic 'why is my app slow' questions.

### Laser-focused skill design

The repo's own guidance: 'Skills in this repo should be laser-focused on a specific task or workflow.' Each skill optimizes for actionable outcomes over generic reference material, which is why setup, components, migrations, and performance are deliberately separate skills.

## API reference

```
npx skills add get-convex/agent-skills
```

Install every Convex skill into the local agent so it can auto-discover them.

```
npx skills add get-convex/agent-skills
```

```
/<skill-name> (manual invocation)
```

Manually trigger a skill in Cursor, Claude Code, or VS Code by typing a slash command with the skill name.

```
/convex-setup-auth
```

```
@<skill-name> / $<skill-name>
```

Alternate invocation prefixes for tools that do not use slash commands — Windsurf uses @, Codex uses $.

```
@convex-quickstart
$convex-performance-audit
```

## Gotchas

- Invocation syntax differs per tool: /skill in Cursor/Claude Code/VS Code, @skill in Windsurf, $skill in Codex — pick the right one or the skill will not fire
- convex-quickstart is for new integrations; for an existing Convex app, prefer the specialized skill (auth, component, migration, audit) instead
- Migrations go through convex-migration-helper for a reason — running ad-hoc mutation scripts on prod data is the canonical foot-gun
- Performance audits assume Convex's reactive query model — applying generic SQL/REST advice will mislead the agent
- Skills are 'laser-focused' on purpose; do not ask one skill to also handle adjacent concerns, route through the convex router skill instead

---
Generated by SkillMake from https://github.com/get-convex/agent-skills on 2026-05-17T04:18:18.377Z.
Verify against source before relying on details.

File: ~/.claude/skills/convex-quickstart/SKILL.md