一般的なConvexワークフローのエージェントスキル。

ライセンス

それ以外の場合は、このリポジトリのすべての元のコンテンツがライセンスされていない Apache ライセンス 2.0 に基づく。 これは、スキルの指示を含みます, 参照文書、およびこのライセンスを含むリビジョンのソースコード 以前のリビジョンのライセンスを遡及的に変更しません。

第三者の資料は、それぞれのライセンスの下に残っています。 お問い合わせ 詳細は THIRD PARTY NOTICES.md をご覧ください。

インストール

使用法

エージェントが関連すると判断したときに、自動的にスキルが適用されます。 使い方 手動で呼び出すと、ツールによって異なります。

例えば、カーソルまたはクロードコードのauth設定をキックオフするには:

ウインドサーフィン:

利用可能なスキル

• [convex - コンベックス作業のトップレベルのエントリーポイント。 Convex のインストールを推奨 より具体的なConvexのスキルに、AIファイルをルーティングします。
• [convex-quickstart - 新しいConvexプロジェクトを開始したり、既存のConvexを追加したりする アプリ.

Convex Agent Skills

Agent skills for common Convex workflows.

License

Unless otherwise noted, all original content in this repository is licensed under the Apache License 2.0. This includes the skill instructions, reference documentation, and source code in revisions that include this license. It does not retroactively change the licensing of earlier revisions.

Third-party materials remain under their respective licenses. See THIRD_PARTY_NOTICES.md for details.

Install

# Choose which skills you want
npx skills add convex/agent-skills

# OR Install all skills
npx skills add convex/agent-skills --all

Usage

Skills are applied automatically when the agent determines they’re relevant. How you manually invoke them depends on your tool:

For example, to kick off auth setup in Cursor or Claude Code:

/convex-setup-auth

In Windsurf:

@convex-setup-auth

Available Skills

• convex - Top-level entry point for Convex work. Recommends installing Convex AI files, then routes to a more specific Convex skill.
• convex-quickstart - Start a new Convex project or add Convex to an existing app.
• convex-setup-auth - Set up authentication for a Convex app.
• convex-create-component - Build a reusable Convex component with clear boundaries.
• convex-migration-helper - Plan and run Convex migrations safely.
• convex-performance-audit - Investigate Convex performance problems and bottlenecks.

Skill Philosophy

Skills in this repo should be laser-focused on a specific task or workflow.

A good skill helps an agent take action, for example:

• set up authentication
• create a component
• perform a migration
• diagnose performance issues

A skill should not exist just to provide generic background information. If content is mostly reference material, it should usually live in documentation, not as a standalone skill.

Reference material is still useful inside a skill, but only when it helps the agent complete a concrete task.

Contributing

Before contributing, review the core Agent Skills docs:

• Overview
• What are skills?
• Specification
• Optimizing skill descriptions
• Evaluating skill output quality

If your skill bundles scripts, also read Using scripts in skills.

Install dependencies once with pnpm install, then use: