$ ~/registry/skill/openclaw-agents-skills-convex-quickstart

SKILL

convex-quickstart

Name: convex-quickstart
Author: openclaw

Set up Convex in a new or existing app quickly.

Stars

★ 9,034

Source

GitHub

Updated

2026-06-25

// securityCaution

Prompt only, no code
Open source

Summary

The material indicates this skill mainly guides users through initializing a Convex project; system checks mark it as prompt-only with no required secrets and no declared remote endpoints, so overall risk is low. Caution is still warranted because the README instructs users to run npm/npx scaffolding and dev commands, which may access the network, write files, and pull third-party templates, so they should be executed manually in a controlled environment.

CredentialsLow risk

The material and system checks indicate no preconfigured API keys or environment variables are required. The README only notes that first-time `npx convex dev` uses browser-based login/OAuth, without asking users to hand credentials to the skill directly, so direct credential exposure is low.

Network egressCaution

Although no fixed remote host is declared in metadata, the README explicitly directs use of `npm create convex@latest`, `npm install`, and `npx convex dev`. These steps typically contact external services such as npm/Convex and may sync project code to a Convex development deployment. This is normal for such tooling but deserves user awareness.

Code executionCaution

The README recommends running local CLI programs (npm/npx) to scaffold projects, install dependencies, and start a long-running dev watcher. That means executing third-party packages locally and spawning persistent processes. This is normal for developer tooling, but it should not be executed automatically without review.

Data accessCaution

The README explicitly states the scaffolder creates project files and that the dev flow writes `.env.local`, generates a `convex/` directory, and produces type files. Data access appears mainly limited to the current project workspace, with no evidence of requesting broad system-level access beyond its stated purpose.

Supply chainCaution

On the positive side, there is a public GitHub repository and the system marks it as open-source/prompt-only, which improves auditability. However, the repository has no declared license, 0 stars, unknown maintenance status, and the README allows using any GitHub repo as a template, shifting supply-chain trust to external template sources; users should choose templates carefully.

Recommendations

Use it primarily as setup guidance; manually review any `npm`/`npx` command and the target template source before execution.
Prefer official Convex templates and avoid unknown GitHub repository templates.
Run scaffolding in an isolated dev directory or temporary environment, and inspect the generated `.env.local` and dependency list.
Before first running `npx convex dev`, confirm you are comfortable with syncing code to a Convex development deployment.

Audited by: gpt-5.4 · 2026-06-17

// install

Copy the install command and let the AI configure it · recommended for beginners

Please install the "convex-quickstart" skill from askskill:
1. Download https://raw.githubusercontent.com/openclaw/clawhub/main/.agents/skills/convex-quickstart/SKILL.md
2. Save it as ~/.claude/skills/convex-quickstart/SKILL.md
3. Reload skills and tell me it's ready

// download

Download SKILL.mdInstall manifest ↗

// examples

Create a new Convex project

Prompt

Help me create a Convex project from scratch using npm create convex@latest, and explain each step including install, initialization, and starting the dev environment.

Expected

A step-by-step guide from creation to startup, including terminal commands and key explanations.

Add Convex to an existing frontend

Prompt

I already have a React frontend project. Guide me through adding Convex, including installing dependencies, configuring the client, setting environment variables, and testing the first connection.

Expected

Integration steps for an existing project, with sample code and environment variable setup instructions.

Run the first local Convex dev session

Prompt

Show me how to complete the first npx convex dev run, including prerequisites, what happens after running the command, and how to troubleshoot common errors.

Expected

A first-run guide covering prerequisites, execution flow, and troubleshooting tips for common issues.

// docs

Convex Quickstart

Set up a working Convex project as fast as possible.

When to Use

Starting a brand new project with Convex
Adding Convex to an existing React, Next.js, Vue, Svelte, or other app
Scaffolding a Convex app for prototyping

When Not to Use

The project already has Convex installed and convex/ exists - just start building
You only need to add auth to an existing Convex app - use the convex-setup-auth skill

Workflow

Determine the starting point: new project or existing app
If new project, pick a template and scaffold with npm create convex@latest
If existing app, install convex and wire up the provider
Run npx convex dev to connect a deployment and start the dev loop
Verify the setup works

Path 1: New Project (Recommended)

Use the official scaffolding tool. It creates a complete project with the frontend framework, Convex backend, and all config wired together.

Pick a template

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
`nextjs-lucia-shadcn`	Next.js + Lucia auth + shadcn/ui
`bare`	Convex backend only, no frontend

If the user has not specified a preference, default to react-vite-shadcn for simple apps or nextjs-shadcn for apps that need SSR or API routes.

You can also use any GitHub repo as a template:

npm create convex@latest my-app -- -t owner/repo
npm create convex@latest my-app -- -t owner/repo#branch

Scaffold the project

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 install

The scaffolding tool creates files but does not run npm install, so you must run it yourself.

To scaffold in the current directory (if it is empty):

npm create convex@latest . -- -t react-vite-shadcn
npm install

Start the dev loop

npx convex dev is a long-running watcher process that syncs backend code to a Convex deployment on every save. It also requires authentication on first run (browser-based OAuth). Both of these make it unsuitable for an agent to run directly.

Ask the user to run this themselves:

Tell 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:

Create a Convex project and dev deployment
Write the deployment URL to .env.local
Create the convex/ directory with generated types
Watch for changes and sync continuously

The user should keep npx convex dev running in the background while you work on code. The watcher will automatically pick up any files you create or edit in convex/.

Exception - cloud or headless agents: Environments that cannot open a browser for interactive login should use Agent Mode (see below) to run anonymously without user interaction.

Start the frontend

The user should also run the frontend dev server in a separate terminal:

npm run dev

Vite apps serve on http://localhost:5173, Next.js on http://localhost:3000.

What you get

After scaffolding, the project structure looks like:

my-app/
  convex/           # Backend functions and schema
    _generated/     # Auto-generated types (check this into git)
    schema.ts       # Database schema (if template includes one)
  src/              # Frontend code (or app/ for Next.js)
  package.json
  .env.local        # CONVEX_URL / VITE_CONVEX_URL / NEXT_PUBLIC_CONVEX_URL

…

View full docs ↗