This repository provides a collection of AI-consumable skills and templates designed to assist developers in building production-ready applications using Convex. It addresses the need for structured guidance and best practices in Convex development, targeting AI assistants and developers seeking to streamline their workflow and ensure robust application architecture. The primary benefit is enabling AI agents to understand and implement complex Convex patterns effectively.

How It Works

The project adheres to the "Agent Skills open format," structuring reusable code patterns, best practices, and guidance into distinct "skills." Each skill is documented within a SKILL.md file, featuring YAML frontmatter for metadata, followed by detailed instructions, examples, and best practices. These skills are packaged as an npm module (@waynesutton/convex-skills) for programmatic use, can be integrated directly by AI models like Claude Code and Codex, or accessed via a CLI for installation into projects.

Quick Start & Requirements

• Installation:
  • npm (global CLI): npm install -g @waynesutton/convex-skills
  • CLI commands: convex-skills list, convex-skills install <skill>, convex-skills install-all, convex-skills install-templates
  • npx: npx @waynesutton/convex-skills install-all
  • Programmatic: npm install @waynesutton/convex-skills
  • AI Integration: Follow specific instructions for Claude Code, Codex, or OpenCode (e.g., cloning the repo, copying skill files).
• Prerequisites: Node.js and npm are required for CLI and programmatic usage. Git is needed for cloning. Specific AI environments may have additional requirements.
• Links:
  • npm: @waynesutton/convex-skills
  • Agent Skills Specification: [Link to Agent Skills Specification - not provided in README, assumed external]

Highlighted Details

• Offers a wide array of skills covering core Convex development areas: functions, realtime, schema validation, file storage, agents, cron jobs, HTTP actions, migrations, and security audits.
• Includes templates for forking developers, providing project context (CLAUDE.md) and development best practices (templates/skills/dev.md).
• Features AI integration files (AGENTS.md, CLAUDE.md, GEMINI.md) to facilitate direct use with AI models.
• Provides a /convex slash command for OpenCode, enabling interactive skill invocation through decision trees.

Maintenance & Community

The repository is maintained by waynesutton. No specific community channels (like Discord or Slack) or notable partnerships are detailed in the README.

Licensing & Compatibility

The project is licensed under the Apache-2.0 License. This license is permissive and generally compatible with commercial use and linking within closed-source projects.

Limitations & Caveats

The project is described as "Convex (unofficial) Skills v1," indicating it is not officially endorsed by Convex, which may impact its alignment with future Convex developments. The effectiveness of the skills is dependent on the AI model's ability to interpret and apply them correctly.