AIPM
Theme

AIPM package

Convex Quickstart

@convex/convex-quickstart@1.0.0

Get a barebones Convex + web template running from a one-sentence idea.

Scanned · no issues · Oct 29, 2026

GitHub stars: ★ 69

LinkedInPost

Install Skill

Pins this version in aipm.package.json and aipm-lock.json.

aipm add @convex/convex-quickstart@1.0.0

Without project tracking

Writes the skill files only. Add --no-init to skip aipm.package.json and the lockfile.

aipm add @convex/convex-quickstart@1.0.0 --no-init

How to use

Install the skill above, then run this in your AI tool:

/convex-quickstart <your description>

About

<!-- GENERATED from convex-agents content/capabilities/quickstart.json — do not edit by hand. -->

Source

What gets added to your project

Preview every file this package writes on install before you run the command above.

Summary

Get a barebones Convex + web template running from a one-sentence idea.

Skill instructions

<!-- GENERATED from convex-agents content/capabilities/quickstart.json — do not edit by hand. -->

Quickstart: a barebones Convex template, running

Stand up a barebones Next.js + Convex template from the idea, locally, with an anonymous dev deployment. Minimal by design: local dev servers, no publish step, no pre-baked auth.

Workflow

  1. Run recipe quickstart-recipe@^2 with {idea, template} (the pack fetches + caches it; pinned offline fallback). It creates the project, installs deps, starts the backend (anonymous) and the web dev server.
  2. When it prints the dev URL, open it for the user.
  3. Present a short plan and CONFIRM before building features beyond the template.

Rules

  • Never re-run the recipe if it already reported success.
  • Delegate any code under convex/ to the convex-expert capability.
  • Don't add Postgres/Redis/Express — use Convex primitives.
  • Don't add hosting/publish or pre-baked auth here — keep the template minimal unless the user asks for more.
  • DEGRADATION RULE — if the scaffold cannot run (non-interactive session, no network, a sandboxed temp dir, or the user just wants code, not an app): skip the recipe and write a standard Convex project directly. ALL backend code goes under convex/ (schema.ts, functions) — NEVER at the project root; Convex functions only run from the convex/ directory. Write ZERO scaffold/documentation files (no START_HERE.md, ARCHITECTURE.md, MANIFEST.txt, README walls) unless explicitly asked. "Build me a backend" means code, not ceremony.
  • Data access + imports — before writing any convex/*.ts: never an unbounded .collect() on a table that can grow — use .withIndex(...) and .paginate(...)/.take(n). Use an index, not .filter(), for anything that would be a SQL WHERE. .withIndex(...) callbacks only have eq/gt/gte/lt/lte — there is no .range(...) method. Imports: query/mutation/action/internalQuery/internalMutation/internalAction come from ./_generated/server; api/internal come from ./_generated/api; NEVER import from convex/server in application code. v.literal("exact value") for fixed string/enum members, not a bare string. "use node" only at the top of action-only modules — never in a file that also exports a query or mutation. Never import a Node builtin (crypto/fs/path/http/child_process/os, with or without the node: prefix) into a file lacking "use node" — including http.ts route handlers; use Web Crypto (crypto.subtle) instead of importing crypto where possible.
  • Reserved names — never export const <jsReservedWord> = ... (e.g. delete, new, class, function, return) as a query/mutation/action export name; esbuild fails to parse it. Never a table or index name starting with _ (e.g. _migrations: defineTable(...)) — _ is reserved and errors at push as TableNameReserved/IndexNameReserved.
  • HTTP routes — httpRouter has no Express-style :param segments (path: "/users/:id" only matches that literal string and is dead code); use pathPrefix and parse the trailing segment yourself. Every http.route({...}) handler: must be wrapped in httpAction(...) from ./_generated/server — a bare async (ctx, request) => {...} type-checks but isn't a valid HTTP action.
  • ctx.runQuery/ctx.runMutation/ctx.runAction need a codegen'd function reference (api.foo.bar/internal.foo.bar), never a raw imported module member (import * as queries from "./queries"; ctx.runQuery(queries.getX, ...) compiles but fails at runtime).
  • SELF-VERIFY RULE — before declaring backend work done, verify it compiles and pushes: run npx tsc --noEmit and push it to a deployment. Prefer the project's existing one; otherwise npx convex dev --once when npx convex whoami succeeds, and CONVEX_AGENT_MODE=anonymous npx convex dev --once ONLY when it does not. Forcing anonymous on a signed-in user rebinds .env.local and costs them the persistent, publishable cloud deployment they expect. Fix every error it reports before finishing — one verify round catches the wrong-relative-import / duplicate-symbol / unbalanced-paren class that otherwise breaks the deploy.

Loading package files…

Share this package

Add an Install with AIPM badge

Add this badge to a GitHub README so readers can open the package page and install the same version.

Install with AIPM
[![Install with AIPM](https://www.aipm-registry.com/install-with-aipm.svg)](https://www.aipm-registry.com/skills/convex/convex-quickstart/1.0.0?utm_source=github&utm_medium=readme&utm_campaign=package_badge)

Publisher

Convex

This imported publisher has not claimed its AIPM account. A connected account confirms account control, but it does not guarantee that a package is safe.

AI assistant context

What this skill is for

@convex/convex-quickstart@1.0.0 is an AIPM skill package for All tools. Use it when a project needs the reusable AI behavior described as: Get a barebones Convex + web template running from a one-sentence idea.

Install
aipm add @convex/convex-quickstart@1.0.0
Use after install
/convex-quickstart <your description>

Tool targets

Install command by target

Add --no-init to any of these when you want the skill files without aipm.package.json or aipm-lock.json.

cursor

Run this variant when you want to install the package into cursor.

aipm add @convex/convex-quickstart@1.0.0 --target cursor --ci

claude

Run this variant when you want to install the package into claude.

aipm add @convex/convex-quickstart@1.0.0 --target claude --ci

Discussion

Comments (0)

Loading comments…

Keep exploring

Convex/convex-explain-app

Explain an existing Convex app — data model + relationships, public vs internal functions, auth/ownership model, components, a request→data flow — read from the schema and function surface. Read-only.

Published by Convex

skillScanned · no issues★ 69Imported · UnverifiedAll toolsNov 19, 2026, 1:09 AM2.45 KBApache-2.0

Convex/convex-suggest

Suggest the matching Convex component when the user hand-rolls a pattern it already solves (crons, sharded-counter, rate-limiter, storage, search, presence, workflow, RAG, prosemirror-sync). Passive — suggest after the task, never interr...

Published by Convex

skillScanned · no issues★ 69Imported · UnverifiedAll toolsNov 19, 2026, 1:09 AM1.58 KBApache-2.0

Convex/convex-domains

Point a domain you already own at your Convex app (DNS records, custom-domain attach, auth-origin rebind).

Published by Convex

skillScanned · no issues★ 69Imported · UnverifiedAll toolsNov 19, 2026, 1:09 AM1.60 KBApache-2.0

Package FAQ

Install and compatibility

How to install
Run aipm add @convex/convex-quickstart@1.0.0 in a project that has AIPM initialized.
Supported tools
@convex/convex-quickstart@1.0.0 supports All tools.

Before installing

AIPM skills can add files to your project. Review the package name, target, description, license, and publisher before installing. Use a clean branch when trying a new skill.