convex-create-component
Convex のアプリの中に、自分の表と関数を持つ「部品(component)」を作らせる。まず部品にする価値があるかを確かめ、認証と環境変数はアプリ側に残す境界の決まりを守らせる
npx skills add get-convex/agent-skills/convex-create-component入れる前にこのスキルがすること・注意点・SKILL.md の原文を確かめてください。解析は安全性の判定ではありません。
- インストール
- 0
- 実用度
- 13
- GitHub star
- 69
- 最終更新
- 2026/10/30
頼み方の例
そのままコピーして使えますconvex-create-componentスキルを使って、このアプリの通知の機能を Convex の部品に切り出す計画を立ててください。部品にする価値があるか、部品が持つ表、外に出す関数、アプリ側に残すものを一覧にしてください。コードはまだ書かないでください。
対象のファイルや状況は、ご自身の作業に合わせて置き換えてください。
このスキルがすること
SKILL.md の記述から機械的に抽出- シェルコマンドを実行する記述があります
- パッケージを導入する記述があります
これは安全性の判定ではありません。 SKILL.md にそう書かれているという事実だけを並べています。実際に問題があるかは使い方と文脈で決まるため、当サイトでは断定しません。導入前に SKILL.md の原文を確認してください。
SKILL.md の規模
コードブロックの言語: ts
いつ使うか
Convex で作っているアプリの一部を、独立した部品に切り出したいときに効きます。Convex の部品(component)は、自分専用の表と関数を持ち、アプリの他の部分から切り離された単位です。
通知、外部サービスとの連携、複数のアプリで使い回す機能などが対象です。
まず、部品にする価値があるかを確かめる
最初にすることは、作ることではなく部品にする価値があるかの確認です。
部品にする
自分の表を持つ連携(外部サービスの状態を保存する)。複数のアプリで使い回す。バックエンドの処理を切り出して再利用する
部品にしない
その場限りの業務の処理。表や関数の要らない小さな便利関数。アプリ全体の段取り(convex/ に置くもの)。普通の TypeScript のライブラリで足りるもの
形を 3 つから選ぶ
価値があれば、形を 3 つから選びます。迷ったら「このアプリ専用(local)」が既定です。
アプリ専用(local)
convex/components/<名前>/ に置く
迷ったらこれ(既定)
配布用(packaged)
npm で公開する、複数のアプリで共有する
両方の混合(hybrid)
明示的に頼まれたときだけ。上級の選択肢
使わないほうがいいとき
Convex を使っていないアプリ
Convex 専用の書き方です。
部品の要らない小さな機能
本文は、表やバックエンドの関数が要らないなら普通のアプリのコードかライブラリを選べ、と繰り返しています。
部品にすると境界の決まりが増えるので、手間に見合うときだけ使ってください。
注意点
解析で分かったこと
SKILL.md の解析では、シェルコマンドの実行(npx convex dev)とパッケージの導入の記述が見つかっています。
同梱ファイルは 6 件で、3 つの形それぞれの資料、進んだ書き方の資料、Codex 向けの設定(agents/openai.yaml)、アイコンです。
境界の決まりが、この部品作りの要
本文が「重要な決まり」として挙げているのは 10 件で、主な 6 件は次のものです。
- 認証はアプリ側で扱う。部品の中では
ctx.authが使えない - 環境変数もアプリ側で読む。部品の関数は
process.envを読めない - アプリの表の ID は、部品には文字列で渡す(
v.id("users")ではなくv.string()) - 画面から部品の関数を直接呼ばせない。アプリ側に包む関数を作る
- HTTP の窓口はアプリの
convex/http.tsに置く。部品は自分で窓口を登録できない - ページ送りは組み込みの
.paginate()ではなくconvex-helpersのpaginatorを使う
残りは、部品の関数は自分の ./_generated/server から読み込む、問い合わせる項目には索引を作り .filter() に頼らない、公開する関数すべてに args と returns の検査を付ける、などです。
新しいリポジトリでは、確かめが止まる
本文は、ログインや配置先の設定で止まったら推測で進めず、その手順を利用者に頼めと決めています。
インストール数
インストール数は約 11 万件です。同じリポジトリの 3 件は約 8.9 万〜11 万件で(2026-09-07 の上流集計)、1 件ずつ選ばれている形です。
インストール数の推移
日次で記録9月18日 〜 11月7日(49日分)
インストール数と 1 日あたりの増加は Skillselion が に集計した値です。上流の更新は数日おきなので、前日比ではありません。GitHub star と最終更新は に GitHub から取得しました。
併用すると強いスキル
よくある質問
作った部品は、アプリからどう呼びますか
アプリの convex/convex.config.ts で app.use(...) して取り込み、components.<名前> を通して ctx.runQuery や ctx.runMutation で呼びます。convex/components/notifications/lib.ts の send なら、components.notifications.lib.send です。
npm で公開したいのですが
配布用の形を選びます。資料は、npx create-convex@latest --component から始めること、公式の作り方の文書を正とすること、例のアプリで組み込んで確かめることを勧めています。公開するなら、取り込み用の設定と型の入口をパッケージから出す必要があります。
部品の中で外部 API の鍵を使いたいです
部品の中では環境変数を読めないので、アプリ側で鍵を読み、関数の引数として部品に渡します。本文に、翻訳の部品に API の鍵を渡す例があります。
Codex でも使えますか
同梱の agents/openai.yaml に Codex 向けの表示名と既定の頼み方が書かれていて、公開元が Codex での利用も想定しています。既定の頼み方も「まず部品にする価値があるかを確かめる」から始まります。