agentleFS
waynesuttonwaynesutton/builder-skills/skills/convex/SKILL.md

convex

Skill404 starsChanged 45 days agoApache-2.0View on GitHub

Routes Convex work to the right builder skill and covers the handful of rules that apply everywhere: validators on every function, withIndex over filter, idempotent mutations, internal functions for scheduling. Use when a task mentions Convex and no more specific skill matches, or as the first stop before picking one.

25 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use convex-migration-helper, convex-performance-audit and 1 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • vantageos-agencySkill

    convex-migration-helper

    Plans and executes safe Convex schema and data migrations using the widen-migrate-narrow workflow and the @convex-dev/migrations component. Use this skill when a deployment fails schema validation, existing documents need backfilling, fields need adding or removing or changing type, tables need splitting or merging, or a zero-downtime migration strategy is needed. Also use when the user mentions breaking schema changes, multi-deploy rollouts, or data transformations on existing Convex tables.

    Also in 8 projects that use this

  • vantageos-agencySkill

    convex-performance-audit

    Audits and optimizes Convex application performance across hot-path reads, write contention, subscription cost, and function limits. Use this skill when a Convex feature is slow or expensive, npx convex insights shows high bytes or documents read, OCC conflict errors or mutation retries appear, subscriptions or UI updates are costly, functions hit execution or transaction limits, or the user mentions performance, latency, read amplification, or invalidation problems in a Convex app.

    Also in 8 projects that use this

  • +1 more from vantageos-agency

The file

We split this skill into the rules it gives an agent

8 rules. 0 are common, 2 are distinctive, and 6 are very specific to this project.

  • 0

    Common

    Most of the 24 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 6

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Start here, pick the matching skill below, and load it.

    line 8
  2. Very specific:

    Every function declares args and returns validators, including internal ones.

    line 35
  3. Very specific:

    Read through withIndex. .filter() on a table scan is a bug waiting for data.

    line 36
  4. Very specific:

    Never call Date.now() inside a query.

    line 39
  5. Very specific:

    Use npx convex dev for development.

    line 40
  6. Very specific:

    Use crons.daily, crons.hourly, or crons.weekly.

    line 46
  7. Very specific:

    Put "use node" in a file that also exports queries or mutations.

    line 47
  8. Distinctive:

    Run git commands that discard work without loading git-safety first.

    line 48

“Common” is measured: kept by at least 6 in 10 of the 24 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Convex

Start here, pick the matching skill below, and load it. If nothing matches, the rules at the bottom still apply.

Pick a skill

SkillLoad when
convex-best-practicesgeneral patterns, project structure, "is this the Convex way"
convex-functionsqueries, mutations, actions, internal functions, error handling
convex-schema-validatortables, indexes, validators, v.* types, schema changes
convex-realtimeuseQuery, optimistic updates, pagination, presence, rerender churn
convex-http-actionswebhooks, REST endpoints, convex/http.ts, Stripe or Clerk callbacks
convex-file-storageuploads, upload URLs, serving files, storage cleanup
convex-cron-jobscrons.ts, runAfter, runAt, batching, a cron that is not firing
convex-migrationsbackfills, renaming fields, schema evolution with live data
convex-agentsAI agents, threads, tools, streaming, RAG with @convex-dev/agent
convex-component-authoringbuilding a reusable component package, defineComponent
convex-security-checkfast pre ship audit: auth on public functions, exposed data
convex-security-auditdeep review: authorization model, injection, rate limits, secrets
avoid-feature-creepscope pushback, MVP cuts, "just one more feature"
project-workflowmulti step tasks, PRDs in prds/, task.md, plans for review
project-docssyncing task.md, changelog.md, files.md with shipped code
git-safetyrevert, undo, reset, checkout, clean, stash, force push

Two skills often apply at once. Load the domain skill for the code and the process skill for the workflow, for example convex-functions plus project-workflow.

Rules that hold everywhere

  • Every function declares args and returns validators, including internal ones.
  • Read through withIndex. .filter() on a table scan is a bug waiting for data.
  • Mutations are idempotent. Check current state, return early when there is nothing to do.
  • Schedule and cron only internal.* functions. Never api.*.
  • Never call Date.now() inside a query. Pass time in as an argument.
  • Use npx convex dev for development. Do not run npx convex deploy unless asked.
  • Fetch https://docs.convex.dev/llms.txt before trusting memory about an API.

Do not

  • Edit anything under convex/_generated/.
  • Use crons.daily, crons.hourly, or crons.weekly. Use crons.interval or crons.cron.
  • Put "use node" in a file that also exports queries or mutations.
  • Run git commands that discard work without loading git-safety first.

Docs

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.