@waynesutton/convex-skills 1.0.0

package/AGENTS.md

@@ -0,0 +1,115 @@
+# Convex Skills
+
+Agent skills for building production-ready applications with Convex, following the Agent Skills open format.
+
+## Overview
+
+This repository contains packaged instructions that help AI coding agents understand and implement Convex best practices. Skills are automatically invoked when relevant to your task.
+
+## Available Skills
+
+| Skill                                                                    | Description                                           |
+| ------------------------------------------------------------------------ | ----------------------------------------------------- |
+| [convex-best-practices](skills/convex-best-practices/SKILL.md)           | Guidelines for building production-ready Convex apps  |
+| [convex-functions](skills/convex-functions/SKILL.md)                     | Writing queries, mutations, actions, and HTTP actions |
+| [convex-realtime](skills/convex-realtime/SKILL.md)                       | Patterns for building reactive applications           |
+| [convex-schema-validator](skills/convex-schema-validator/SKILL.md)       | Database schema definition and validation             |
+| [convex-file-storage](skills/convex-file-storage/SKILL.md)               | File upload, storage, and serving                     |
+| [convex-agents](skills/convex-agents/SKILL.md)                           | Building AI agents with Convex                        |
+| [convex-cron-jobs](skills/convex-cron-jobs/SKILL.md)                     | Scheduled functions and background tasks              |
+| [convex-http-actions](skills/convex-http-actions/SKILL.md)               | HTTP endpoints and webhook handling                   |
+| [convex-migrations](skills/convex-migrations/SKILL.md)                   | Schema evolution and data migrations                  |
+| [convex-security-check](skills/convex-security-check/SKILL.md)           | Quick security audit checklist                        |
+| [convex-security-audit](skills/convex-security-audit/SKILL.md)           | Deep security review patterns                         |
+| [convex-component-authoring](skills/convex-component-authoring/SKILL.md) | Creating reusable Convex components                   |
+
+## Skill Format
+
+Each skill follows the Agent Skills specification with YAML frontmatter:
+
+```markdown
+---
+name: skill-name
+description: What the skill does and when to use it
+version: 1.0.0
+author: Convex
+tags: [convex, ...]
+---
+
+# Skill Name
+
+## Documentation Sources
+
+Links to official documentation
+
+## Instructions
+
+Step-by-step guidance
+
+## Examples
+
+Code examples
+
+## Best Practices
+
+Guidelines and patterns
+
+## References
+
+Additional resources
+```
+
+## Usage
+
+Skills are automatically available once installed. The agent will use them when relevant tasks are detected.
+
+**Examples:**
+
+```
+Help me set up file uploads in Convex
+```
+
+```
+Create a cron job to clean up expired sessions
+```
+
+```
+Add a Stripe webhook endpoint
+```
+
+## Key Convex Concepts
+
+### Function Types
+
+| Type         | Purpose        | Database                 | External APIs |
+| ------------ | -------------- | ------------------------ | ------------- |
+| `query`      | Read data      | Read-only                | No            |
+| `mutation`   | Write data     | Read/Write               | No            |
+| `action`     | Integrations   | Via runQuery/runMutation | Yes           |
+| `httpAction` | HTTP endpoints | Via runQuery/runMutation | Yes           |
+
+### Core Principles
+
+1. **Always use validators** for arguments and returns
+2. **Use indexes** instead of filters for queries
+3. **Make mutations idempotent** with early returns
+4. **Use internal functions** for sensitive operations
+5. **Batch operations** for large datasets
+
+## DO NOT
+
+- Run `npx convex deploy` without explicit instruction
+- Run any git commands without explicit instruction
+- Edit files in `convex/_generated/`
+- Use `filter()` instead of `withIndex()`
+
+## References
+
+- Convex Documentation: https://docs.convex.dev/
+- Convex LLMs.txt: https://docs.convex.dev/llms.txt
+- Best Practices: https://docs.convex.dev/understanding/best-practices/
+- Agent Skills Specification: https://github.com/anthropics/skills
+
+## License
+
+Apache-2.0

package/GEMINI.md

@@ -0,0 +1,103 @@
+# Convex Development Context
+
+This file provides context for Gemini CLI when working with Convex projects.
+
+## Project Type
+
+Convex real-time backend application with TypeScript.
+
+## Key Technologies
+
+- **Convex** - Serverless database and functions platform
+- **TypeScript** - Type-safe JavaScript
+- **React** - Frontend framework (typical Convex frontend)
+
+## Convex-Specific Guidelines
+
+### Function Types
+
+| Type | Purpose | Database Access | External APIs |
+|------|---------|-----------------|---------------|
+| `query` | Read data | Read-only | No |
+| `mutation` | Modify data | Read/Write | No |
+| `action` | External integrations | Via runQuery/runMutation | Yes |
+| `httpAction` | Webhooks/APIs | Via runQuery/runMutation | Yes |
+
+### Best Practices
+
+1. **Always use validators** for args and returns
+2. **Use indexes** instead of filters for queries
+3. **Make mutations idempotent** for write conflict handling
+4. **Use internal functions** for sensitive operations
+
+### Commands
+
+```bash
+# Start development
+npx convex dev
+
+# Generate types
+npx convex codegen
+
+# View logs
+npx convex logs
+
+# Open dashboard
+npx convex dashboard
+```
+
+### Do NOT Run Without Instruction
+
+- `npx convex deploy` - Production deployment
+- Any git commands
+
+## Schema Reference
+
+Schema is defined in `convex/schema.ts`:
+
+```typescript
+import { defineSchema, defineTable } from "convex/server";
+import { v } from "convex/values";
+
+export default defineSchema({
+  // Tables defined here
+});
+```
+
+## Available Functions
+
+Functions are in the `convex/` directory:
+- Queries: Read-only data access
+- Mutations: Data modifications
+- Actions: External API calls
+
+## Documentation
+
+- Convex Docs: https://docs.convex.dev/
+- LLMs.txt: https://docs.convex.dev/llms.txt
+- Convex Skills: https://github.com/get-convex/convex-skills
+
+## Error Handling
+
+Use `ConvexError` for user-facing errors:
+
+```typescript
+import { ConvexError } from "convex/values";
+
+throw new ConvexError({
+  code: "NOT_FOUND",
+  message: "Resource not found"
+});
+```
+
+## File Structure
+
+```
+project/
+├── convex/
+│   ├── _generated/     # Auto-generated (don't edit)
+│   ├── schema.ts       # Database schema
+│   └── *.ts           # Function files
+├── src/               # Frontend code
+└── package.json
+```

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2026 Convex, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,221 @@
+# Convex (unoffical) Skills v1
+
+A collection of AI-consumable skills for building production-ready applications with [Convex](https://convex.dev), following the Agent Skills open format.
+
+## Overview
+
+This repository contains skills that help AI assistants understand and implement Convex best practices. Each skill provides structured guidance for specific aspects of Convex development.
+
+## Installation
+
+### Claude Code (via Marketplace)
+
+```bash
+# Add the marketplace
+claude plugin marketplace add get-convex/skills
+
+# Install the plugin
+claude plugin install convex-skills
+```
+
+### Claude Code (from local clone)
+
+```bash
+git clone https://github.com/get-convex/skills.git
+cd skills
+# Point Claude Code to this directory
+```
+
+### Codex
+
+Follow the Codex skills guide and place the skill under `$CODEX_HOME/skills`:
+
+```bash
+# From the repo root
+# Defaults to ~/.codex if CODEX_HOME is unset
+cp -r skills/convex-best-practices "$CODEX_HOME/skills/"
+```
+
+Codex will auto-discover `SKILL.md` files in that directory on the next start.
+
+### OpenCode
+
+OpenCode discovers skills from `~/.claude/skills/<name>/SKILL.md` automatically. See OpenCode Skills docs for more details.
+
+### Manual Installation
+
+Copy the desired skill's `SKILL.md` file to your project's `.claude/skills/` directory.
+
+## Available Skills
+
+| Skill                                                                    | Description                                           |
+| ------------------------------------------------------------------------ | ----------------------------------------------------- |
+| [convex-best-practices](skills/convex-best-practices/SKILL.md)           | Guidelines for building production-ready Convex apps  |
+| [convex-functions](skills/convex-functions/SKILL.md)                     | Writing queries, mutations, actions, and HTTP actions |
+| [convex-realtime](skills/convex-realtime/SKILL.md)                       | Patterns for building reactive applications           |
+| [convex-schema-validator](skills/convex-schema-validator/SKILL.md)       | Database schema definition and validation             |
+| [convex-file-storage](skills/convex-file-storage/SKILL.md)               | File upload, storage, and serving                     |
+| [convex-agents](skills/convex-agents/SKILL.md)                           | Building AI agents with Convex                        |
+| [convex-cron-jobs](skills/convex-cron-jobs/SKILL.md)                     | Scheduled functions and background tasks              |
+| [convex-http-actions](skills/convex-http-actions/SKILL.md)               | HTTP endpoints and webhook handling                   |
+| [convex-migrations](skills/convex-migrations/SKILL.md)                   | Schema evolution and data migrations                  |
+| [convex-security-check](skills/convex-security-check/SKILL.md)           | Quick security audit checklist                        |
+| [convex-security-audit](skills/convex-security-audit/SKILL.md)           | Deep security review patterns                         |
+| [convex-component-authoring](skills/convex-component-authoring/SKILL.md) | Creating reusable Convex components                   |
+
+## Repository Structure
+
+```
+convex-skills/
+├── skills/                   # Core Convex skills for AI agents
+│   ├── convex-best-practices/
+│   │   └── SKILL.md
+│   ├── convex-functions/
+│   │   └── SKILL.md
+│   ├── convex-cron-jobs/
+│   │   └── SKILL.md
+│   └── ...
+├── templates/                # Templates for forking developers
+│   ├── CLAUDE.md             # Project context template
+│   └── skills/               # Claude Code skill templates
+│       ├── dev.md            # Full-stack development practices
+│       ├── help.md           # Problem-solving methodology
+│       └── gitrules.md       # Git safety protocols
+├── .claude/skills/           # Active skills for this repo
+├── prds/                     # Planning documents
+├── AGENTS.md                 # Agent-facing documentation
+├── CLAUDE.md                 # Claude configuration
+├── GEMINI.md                 # Gemini CLI integration
+├── README.md                 # This file
+└── LICENSE                   # Apache-2.0
+```
+
+## Templates for Forking
+
+When you fork this repository, you can copy the templates to set up Claude Code skills for your project:
+
+```bash
+# Copy skill templates to your project
+cp -r templates/skills/* .claude/skills/
+
+# Or copy specific skills
+cp templates/skills/dev.md .claude/skills/
+cp templates/skills/help.md .claude/skills/
+cp templates/skills/gitrules.md .claude/skills/
+```
+
+| Template                                                     | Description                                  |
+| ------------------------------------------------------------ | -------------------------------------------- |
+| [templates/CLAUDE.md](templates/CLAUDE.md)                   | Project context template for Convex projects |
+| [templates/skills/dev.md](templates/skills/dev.md)           | Full-stack development practices             |
+| [templates/skills/help.md](templates/skills/help.md)         | Problem-solving methodology                  |
+| [templates/skills/gitrules.md](templates/skills/gitrules.md) | Git safety protocols                         |
+
+See [templates/skills/README.md](templates/skills/README.md) for detailed installation instructions.
+
+## Skill Format
+
+Each skill follows the Agent Skills specification:
+
+```markdown
+---
+name: Skill Name
+description: Brief description
+version: 1.0.0
+author: Convex
+tags: [convex, ...]
+---
+
+# Skill Name
+
+## Documentation Sources
+
+## Instructions
+
+## Examples
+
+## Best Practices
+
+## References
+```
+
+## Usage
+
+Skills are automatically available once installed. The agent will use them when relevant tasks are detected.
+
+**Examples:**
+
+```
+Help me set up file uploads in Convex
+```
+
+```
+Create a cron job to clean up expired sessions
+```
+
+```
+Add a webhook endpoint for Stripe
+```
+
+## Creating New Skills
+
+Skills follow the Agent Skills specification. Each skill requires a `SKILL.md` file with YAML frontmatter.
+
+### Skill Template
+
+Create a new directory under `skills/`:
+
+```
+skills/my-skill/
+└── SKILL.md
+```
+
+**SKILL.md format:**
+
+```markdown
+---
+name: my-skill
+description: A clear description of what this skill does
+version: 1.0.0
+author: Convex
+tags: [convex, relevant-tags]
+---
+
+# My Skill Name
+
+## Documentation Sources
+
+Links to official documentation
+
+## Instructions
+
+Step-by-step guidance for the agent
+
+## Examples
+
+Concrete examples showing expected code patterns
+
+## Best Practices
+
+Specific rules to follow
+
+## References
+
+Additional resources
+```
+
+## AI Integration Files
+
+- `AGENTS.md` - Agent-facing documentation
+- `CLAUDE.md` - Claude configuration for Convex projects
+- `GEMINI.md` - Gemini CLI integration for Convex projects
+
+## License
+
+Apache-2.0 License - see [LICENSE](LICENSE) for details.
+
+## References
+
+- [Convex Documentation](https://docs.convex.dev/)
+- [Convex LLMs.txt](https://docs.convex.dev/llms.txt)
+- [Agent Skills Specification](https://github.com/anthropics/skills)