Convex Quickstart
spokvulcan/poker-planning
Creates or adds Convex to an app. An agent skill from spokvulcan/poker-planning.
Initialize a new Convex project from scratch or add Convex to an existing app.
$ npx skills add waynesutton/markdown-site --skill convex-quickstart -a claude-codeProject install by default; add -g for ~/.claude/skills/.
$ gh skill install waynesutton/markdown-site convex-quickstart --agent claude-codeProject scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).
$ git clone --depth 1 https://github.com/waynesutton/markdown-site.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/convex-quickstart .claude/skills/convex-quickstart && rm -rf skills-srcUse ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.
Claude Code skills documentation · loads skills from .claude/skills/
Install the "convex-quickstart" agent skill from https://github.com/waynesutton/markdown-site/tree/main/.claude/convex-quickstart into .claude/skills/convex-quickstart/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "convex-quickstart", then confirm the skill loads.Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$skill-installer install https://github.com/waynesutton/markdown-site/tree/main/.claude/convex-quickstartType this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.
$ npx skills add waynesutton/markdown-site --skill convex-quickstart -a codexProject install goes to .agents/skills/; add -g for ~/.codex/skills/.
$ gh skill install waynesutton/markdown-site convex-quickstart --agent codexProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/waynesutton/markdown-site.git skills-src && mkdir -p .agents/skills && cp -r skills-src/.claude/convex-quickstart .agents/skills/convex-quickstart && rm -rf skills-srcUse ~/.agents/skills/ instead of .agents/skills for a personal install.
Codex skills documentation · loads skills from .agents/skills/
Install the "convex-quickstart" agent skill from https://github.com/waynesutton/markdown-site/tree/main/.claude/convex-quickstart into .agents/skills/convex-quickstart/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "convex-quickstart", then confirm the skill loads.Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add waynesutton/markdown-site --skill convex-quickstart -a cursorProject install goes to .agents/skills/; add -g for ~/.cursor/skills/.
$ gh skill install waynesutton/markdown-site convex-quickstart --agent cursorProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/waynesutton/markdown-site.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/.claude/convex-quickstart .cursor/skills/convex-quickstart && rm -rf skills-srcUse ~/.cursor/skills/ instead of .cursor/skills for a personal install.
Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/
Install the "convex-quickstart" agent skill from https://github.com/waynesutton/markdown-site/tree/main/.claude/convex-quickstart into .cursor/skills/convex-quickstart/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "convex-quickstart", then confirm the skill loads.Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gemini skills install https://github.com/waynesutton/markdown-site.git --path .claude/convex-quickstart--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.
$ npx skills add waynesutton/markdown-site --skill convex-quickstart -a gemini-cliProject install goes to .agents/skills/; add -g for ~/.gemini/skills/.
$ gh skill install waynesutton/markdown-site convex-quickstart --agent gemini-cliProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/waynesutton/markdown-site.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/.claude/convex-quickstart .gemini/skills/convex-quickstart && rm -rf skills-srcUse ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.
Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/
Install the "convex-quickstart" agent skill from https://github.com/waynesutton/markdown-site/tree/main/.claude/convex-quickstart into .gemini/skills/convex-quickstart/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "convex-quickstart", then confirm the skill loads.Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ gh skill install waynesutton/markdown-site convex-quickstartInstalls for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).
$ npx skills add waynesutton/markdown-site --skill convex-quickstart -a github-copilotProject install goes to .agents/skills/; add -g for ~/.copilot/skills/.
$ git clone --depth 1 https://github.com/waynesutton/markdown-site.git skills-src && mkdir -p .github/skills && cp -r skills-src/.claude/convex-quickstart .github/skills/convex-quickstart && rm -rf skills-srcUse ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.
GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/
Install the "convex-quickstart" agent skill from https://github.com/waynesutton/markdown-site/tree/main/.claude/convex-quickstart into .github/skills/convex-quickstart/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "convex-quickstart", then confirm the skill loads.GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
$ npx skills add waynesutton/markdown-site --skill convex-quickstart -a opencodeOpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.
$ gh skill install waynesutton/markdown-site convex-quickstart --agent opencodeProject scope by default (.agents/skills/); add --scope user for a personal install.
$ git clone --depth 1 https://github.com/waynesutton/markdown-site.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/.claude/convex-quickstart .opencode/skills/convex-quickstart && rm -rf skills-srcUse ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.
OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/
Install the "convex-quickstart" agent skill from https://github.com/waynesutton/markdown-site/tree/main/.claude/convex-quickstart into .opencode/skills/convex-quickstart/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "convex-quickstart", then confirm the skill loads.OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.
convex-quickstartInitialize a new Convex project from scratch or add Convex to an existing app.
Convex Quickstart is an agent skill from waynesutton/markdown-site. Initialize a new Convex project from scratch or add Convex to an existing app. Use when starting a new project with Convex, scaffolding a Convex app, or integrating Convex into an existing frontend.
Its SKILL.md is about 1.2k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.
It sits in Frontend & Design, covering Project scaffolding. It works with Next.js, shadcn/ui, Vite and React. The repository describes itself as: An open-source publishing framework built for AI agents and developers to ship websites, docs, or blogs. Write markdown, sync from the terminal. Your content is instantly… The licence is MIT.
5 steps, taken from the first numbered list in SKILL.md.
Read from SKILL.md and the folder at commit 3872c59. It shows what the files ask for, not the result of running them.
Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.
From allowed-tools in the SKILL.md frontmatter.
Shell commands in SKILL.md call:
npmnpxFrom the folder's file list and the shell code blocks in SKILL.md.
Links to these hosts (documentation or services it may open):
github.comFrom URLs in SKILL.md, links to its own repository left out.
Names no API keys, tokens, secrets or passwords.
From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.
Convex Quickstart loads about 1.2k tokens when it runs. Until then it costs about 54 tokens; SKILL.md has 357 words of instructions outside code blocks.
Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.
The automated check noted patterns worth knowing about, such as sudo or a known installer.
- Write the deployment URL to `.env.local`- [ ] `.env.local` has the deployment URLAutomated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.
The full file from waynesutton/markdown-site at commit 3872c59, republished under its MIT licence (© waynesutton). 357 words, ~1,238 tokens.
.claude/skills/convex-quickstart/SKILL.md (or your agent's skills folder).Set up a working Convex project as fast as possible.
convex/ exists: just start buildingconvex-setup-auth skillnpm create convex@latestconvex and wire up the providernpx convex dev to connect a deployment and start the dev loop| Template | Stack |
|---|---|
react-vite-shadcn | React + Vite + Tailwind + shadcn/ui |
nextjs-shadcn | Next.js App Router + Tailwind + shadcn/ui |
react-vite-clerk-shadcn | React + Vite + Clerk auth + shadcn/ui |
nextjs-clerk | Next.js + Clerk auth |
nextjs-convexauth-shadcn | Next.js + Convex Auth + shadcn/ui |
bare | Convex backend only, no frontend |
Default to react-vite-shadcn for simple apps or nextjs-shadcn for apps that need SSR or API routes.
Always pass the project name and template flag to avoid interactive prompts:
npm create convex@latest my-app -- -t react-vite-shadcn
cd my-app
npm installAsk the user to run npx convex dev in their terminal. On first run it will prompt them to log in or develop anonymously. Once running, it will:
.env.localconvex/ directory with generated typesnpm install convex// src/main.tsx
import { StrictMode } from "react";
import { createRoot } from "react-dom/client";
import { ConvexProvider, ConvexReactClient } from "convex/react";
import App from "./App";
const convex = new ConvexReactClient(import.meta.env.VITE_CONVEX_URL as string);
createRoot(document.getElementById("root")!).render(
<StrictMode>
<ConvexProvider client={convex}>
<App />
</ConvexProvider>
</StrictMode>,
);// app/ConvexClientProvider.tsx
"use client";
import { ConvexProvider, ConvexReactClient } from "convex/react";
import { ReactNode } from "react";
const convex = new ConvexReactClient(process.env.NEXT_PUBLIC_CONVEX_URL!);
export function ConvexClientProvider({ children }: { children: ReactNode }) {
return <ConvexProvider client={convex}>{children}</ConvexProvider>;
}| Framework | Variable |
|---|---|
| Vite | VITE_CONVEX_URL |
| Next.js | NEXT_PUBLIC_CONVEX_URL |
| Remix | CONVEX_URL |
| React Native | EXPO_PUBLIC_CONVEX_URL |
convex/schema.ts:
import { defineSchema, defineTable } from "convex/server";
import { v } from "convex/values";
export default defineSchema({
tasks: defineTable({
text: v.string(),
completed: v.boolean(),
}),
});convex/tasks.ts:
import { query, mutation } from "./_generated/server";
import { v } from "convex/values";
export const list = query({
args: {},
handler: async (ctx) => {
return await ctx.db.query("tasks").collect();
},
});
export const create = mutation({
args: { text: v.string() },
handler: async (ctx, args) => {
await ctx.db.insert("tasks", { text: args.text, completed: false });
},
});Use in a React component:
import { useQuery, useMutation } from "convex/react";
import { api } from "../convex/_generated/api";
function Tasks() {
const tasks = useQuery(api.tasks.list);
const create = useMutation(api.tasks.create);
return (
<div>
<button onClick={() => create({ text: "New task" })}>Add</button>
{tasks?.map((t) => <div key={t._id}>{t.text}</div>)}
</div>
);
}npm create convex@latest using appropriate templateconvex and wired up the providernpx convex dev running and connected to a deploymentconvex/_generated/ directory exists with types.env.local has the deployment URL© waynesutton, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file
Just SKILL.md in .claude/convex-quickstart of waynesutton/markdown-site.
Open the folder on GitHubat commit 3872c59
Convex Quickstart next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.
| Skill | Stars | Used in | Tokens | Auto-check | Licence | Repo updated |
|---|---|---|---|---|---|---|
| Convex Quickstart this skillwaynesutton/markdown-site | 628 | — | ~1.2k | Automated safety check: Notes | MIT | |
| Convex Quickstartspokvulcan/poker-planning | 114 | 6 repos | ~3.5k | Automated safety check: Notes | MIT | |
| Creative Tim UI Blockscreativetimofficial/ui | 12k | — | ~2.1k | Automated safety check: Notes | MIT | |
| Frontend Design UltimateaAAaqwq/AGI-Super-Team | 105 | 2 repos | ~2.7k | Automated safety check: Pass | MIT | |
| Shadcn Tailwind UILiarMTTT/TavernWeave | 150 | — | ~1.7k | Automated safety check: Pass | Custom licence | |
| NEAR dApp Builderinternet-court/internet-court-skill | 6.4k | 1 repos | ~684 | Automated safety check: Pass | Custom licence |
spokvulcan/poker-planning
Creates or adds Convex to an app. An agent skill from spokvulcan/poker-planning.
creativetimofficial/ui
Helps install, generate and review Creative Tim UI blocks: shadcn/ui-based React and Tailwind sections that follow a restrained, production-minded design philosophy.
aAAaqwq/AGI-Super-Team
Create distinctive, production-grade static sites with React, Tailwind CSS, and shadcn/ui — no mockups needed.
LiarMTTT/TavernWeave
Build, restyle, or review accessible React interfaces that use shadcn/ui, Radix UI primitives, and Tailwind CSS.
internet-court/internet-court-skill
Scaffolds new NEAR dApps with create-near-app or adds NEAR wallet sign-in, contract calls and transaction signing to an existing React or plain JavaScript app.
IgorWarzocha/Opencode-Workflows
Initialize shadcn/ui + Tailwind CSS v4 in Vite projects (Vite-specific, not Next.js/Remix).
waynesutton/markdown-site
Integrate Convex static self hosting into existing apps using the latest upstream instructions from get-convex/self-hosting every time.
waynesutton/markdown-site
Integrate and maintain Robelest Convex Auth in apps by always checking upstream before implementation.
waynesutton/markdown-site
Plan and execute Convex schema migrations safely, including adding fields, creating tables, and data transformations.
waynesutton/markdown-site
Guide for when to use and when not to use return validators in Convex functions.
waynesutton/markdown-site
Run convex-doctor static analysis, interpret findings, and fix issues across security, performance, correctness, schema, and architecture categories.
waynesutton/markdown-site
Set up Convex authentication with proper user management, identity mapping, and access control patterns.
Categories
Initialize a new Convex project from scratch or add Convex to an existing app. Convex Quickstart is an agent skill from waynesutton/markdown-site. Initialize a new Convex project from scratch or add Convex to an existing app.
Convex Quickstart fits situations like: starting a new project with Convex; scaffolding a Convex app; integrating Convex into an existing frontend.
Run `npx skills add waynesutton/markdown-site --skill convex-quickstart -a claude-code`. Or copy the skill folder (.claude/convex-quickstart in waynesutton/markdown-site) into .claude/skills/convex-quickstart in your project. Claude Code loads it when a task matches its description.
Run `npx skills add waynesutton/markdown-site --skill convex-quickstart -a codex`. Or copy the skill folder (.claude/convex-quickstart in waynesutton/markdown-site) into .agents/skills/convex-quickstart in your project. Codex loads it when a task matches its description.
Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add waynesutton/markdown-site --skill convex-quickstart -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/convex-quickstart, .gemini/skills/convex-quickstart, .github/skills/convex-quickstart and .opencode/skills/convex-quickstart in your project.
Going by SKILL.md and its folder, Convex Quickstart needs the command-line tools its instructions call (npm and npx). Our summary lists: Node.js.
SKILL.md names 1 domain. As links in the text: github.com. This is read from the text; nothing was executed.
Our automated static check of SKILL.md found notes only (mentions a .env file), nothing it rates as a warning. It is not a guarantee. Review the folder before installing.
Convex Quickstart is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.
About 1.2k tokens (SKILL.md is roughly 5k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.
Skills that share tags, products or a category with Convex Quickstart: Convex Quickstart (spokvulcan/poker-planning, 114 stars), Creative Tim UI Blocks (creativetimofficial/ui, 12k stars), Frontend Design Ultimate (aAAaqwq/AGI-Super-Team, 105 stars) and Shadcn Tailwind UI (LiarMTTT/TavernWeave, 150 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.
waynesutton (a GitHub user) maintains it in waynesutton/markdown-site, which has 628 GitHub stars. The repository holds 17 skills in this directory. The repository was last updated on May 20, 2026.
Source: waynesutton/markdown-site on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.