ai-custom-template-prompt
v0.3.3
Published
CLI tool for managing AI custom templates (Cursor, Claude, Agents)
Readme
ai-custom-template-prompt
AI開発ツール(Cursor、Claude、Agents)向けのカスタムテンプレート管理CLIツールです。
クイックスタート
# npxで直接実行(インストール不要)
npx ai-custom-template-prompt init
npx ai-custom-template-prompt list
npx ai-custom-template-prompt add cursor-rules
npx ai-custom-template-prompt doctor
npx ai-custom-template-prompt update-readme
npx ai-custom-template-prompt release patch主な機能
- ✅ Cursorルール: コード品質、テスト、コーディング規約のルール定義
- ✅ ネストされたルール: ディレクトリ別にルールを適用(backend/frontend/server)
- ✅ Cursorコマンド:
/で呼び出せる再利用可能なワークフロー(PR作成、ブランチ作成など) - ✅ 自動適用: ファイルタイプやディレクトリに応じて自動的にルールを適用
- ✅ Manualルール:
@ruleNameで明示的に指定して使用
インストール
GitHub Packages(Private)からインストール
チーム内で使用する場合:
# .npmrcファイルを作成(.npmrc.exampleを参考)
# GitHub Personal Access Tokenが必要(repo, write:packages, read:packages権限)
npm install @redamoon/ai-custom-template-prompt --registry=https://npm.pkg.github.com
# または、グローバルインストール
npm install -g @redamoon/ai-custom-template-prompt --registry=https://npm.pkg.github.comPublic npmからインストール
# グローバルインストール
npm install -g ai-custom-template-prompt
# または、ローカルインストール
npm install ai-custom-template-prompt
# または、npxで直接実行(インストール不要)
npx ai-custom-template-prompt list
npx ai-custom-template-prompt init
npx ai-custom-template-prompt add cursor-rules
npx ai-custom-template-prompt doctor開発用インストール
# リポジトリをクローン
git clone https://github.com/redamoon/ai-custom-template-prompt.git
cd ai-custom-template-prompt
# 依存関係のインストール
pnpm install使用方法
コマンド一覧
| コマンド | 説明 |
|---------|------|
| init | 初回セットアップ(対話式でテンプレートを選択) |
| add <template> | 指定テンプレートを追加 |
| list | 利用可能なテンプレート一覧を表示 |
| doctor | 設定チェック(テンプレートファイルの配置状況を確認) |
| update-readme | READMEを自動生成 |
| release <type> | リリースを実行(patch/minor/major) |
初回セットアップ(対話式)
# インストール済みの場合
ai-custom-template-prompt init
# または npxで実行
npx ai-custom-template-prompt init対話式でテンプレートを選択してセットアップできます。
テンプレートを追加
# インストール済みの場合
ai-custom-template-prompt add cursor-rules
# または npxで実行
npx ai-custom-template-prompt add cursor-rules利用可能なテンプレート名:
cursor-rules- Cursor用基本ルールファイル(常に適用)cursor-manual-rules- Manualルール(@manual-rulesで明示的に指定)cursor-test-rules- テストファイル用ルール(自動適用)cursor-api-rules- API関連コード用ルール(自動適用)cursor-backend-rules- バックエンド用ルール(ネスト:backend/.cursor/rules/)cursor-frontend-rules- フロントエンド用ルール(ネスト:frontend/.cursor/rules/)cursor-server-rules- サーバー用ルール(ネスト:backend/server/.cursor/rules/)cursor-commands- Cursorコマンドディレクトリ全体(/で呼び出し可能)cursor-command-create-pr- PR作成コマンドcursor-command-create-branch- ブランチ作成コマンドcursor-command-update-readme- README更新コマンドcursor-command-release- リリースコマンドcursor-prompts- Cursor用プロンプトファイルclaude-hooks- Claude用カスタムフックagents- Agents設定ファイル
テンプレート一覧を表示
# インストール済みの場合
ai-custom-template-prompt list
# または npxで実行
npx ai-custom-template-prompt list設定チェック
# インストール済みの場合
ai-custom-template-prompt doctor
# または npxで実行
npx ai-custom-template-prompt doctorプロジェクト内のテンプレートファイルの配置状況を確認できます。
テンプレートの配置先
プロジェクトルートのルール
.cursor/rules.mdc- Cursor基本ルール(常に適用).cursor/rules/manual-rules.mdc- Manualルール(@manual-rulesで指定).cursor/rules/test-rules.mdc- テストファイル用ルール(自動適用).cursor/rules/api-rules.mdc- API関連コード用ルール(自動適用).cursor/prompts.mdc- Cursorプロンプト
ネストされたルール(ディレクトリ別)
backend/.cursor/rules/backend-rules.mdc- バックエンド用ルールfrontend/.cursor/rules/frontend-rules.mdc- フロントエンド用ルールbackend/server/.cursor/rules/server-rules.mdc- サーバー用ルール
Cursorコマンド
.cursor/commands/create-pr.md- PR作成コマンド(/create-prで呼び出し).cursor/commands/create-branch.md- ブランチ作成コマンド(/create-branchで呼び出し)
コマンドはチャット入力欄で / を入力すると自動的に表示され、ワークフローを標準化できます。
その他のテンプレート
.claude/custom-hooks.md- Claudeフック(Claude Desktop用)AGENTS.md- Agents設定(プロジェクトルート)
ルールの適用方法
- 基本ルール (
rules.mdc):alwaysApply: trueで常に適用 - Manualルール (
manual-rules.mdc):@manual-rulesで明示的に指定した場合のみ適用 - テストルール (
test-rules.mdc):globs: ["**/*.test.ts"]でテストファイルに自動適用 - APIルール (
api-rules.mdc):globs: ["**/api/**/*"]でAPIディレクトリに自動適用 - バックエンドルール (
backend-rules.mdc):globs: ["backend/**/*"]でバックエンドディレクトリに自動適用 - フロントエンドルール (
frontend-rules.mdc):globs: ["frontend/**/*"]でフロントエンドディレクトリに自動適用 - サーバールール (
server-rules.mdc):globs: ["backend/server/**/*"]でサーバーディレクトリに自動適用
ネストされたルールの動作
Cursorは、ファイルが参照されたときに、そのファイルが含まれるディレクトリの.cursor/rulesディレクトリ内のルールを自動的に適用します。
例:
backend/api/users.tsを開くと →backend/.cursor/rules/backend-rules.mdcが適用されるfrontend/components/Button.tsxを開くと →frontend/.cursor/rules/frontend-rules.mdcが適用されるbackend/server/index.tsを開くと →backend/server/.cursor/rules/server-rules.mdcが適用される
ビルド
# TypeScriptをコンパイル
pnpm build
# ビルド後は dist/ ディレクトリに出力されるローカルでCLIをリンクして使用
# プロジェクトをグローバルにリンク
pnpm link --global
# または、別のプロジェクトからリンク
cd /path/to/your-project
pnpm link ai-custom-template-prompt
# CLIコマンドが使用可能になる
ai-custom-template-prompt list
ai-custom-template-prompt init
ai-custom-template-prompt add cursor-rules
ai-custom-template-prompt doctor開発
ローカル開発環境のセットアップ
# リポジトリをクローン
git clone https://github.com/redamoon/ai-custom-template-prompt.git
cd ai-custom-template-prompt
# 依存関係のインストール
pnpm install
# 開発モードで実行(tsxを使用)
pnpm dev <command>動作確認手順
依存関係のインストール
pnpm installテンプレート一覧の確認
pnpm dev list対話式セットアップのテスト
pnpm dev init単体テンプレート追加のテスト
pnpm dev add cursor-rules設定チェックのテスト
pnpm dev doctor
テンプレートのカスタマイズ
templates/ ディレクトリ内のファイルを編集することで、テンプレートの内容をカスタマイズできます。
Cursorルール
templates/cursor/rules.mdc- 基本ルール(コード品質、テスト、コーディング規約)templates/cursor/manual-rules.mdc- Manualルール(高度なパターン)templates/cursor/test-rules.mdc- テストファイル用ルールtemplates/cursor/api-rules.mdc- API関連コード用ルールtemplates/cursor/backend-rules.mdc- バックエンド用ルールtemplates/cursor/frontend-rules.mdc- フロントエンド用ルールtemplates/cursor/server-rules.mdc- サーバー用ルール
Cursorコマンド
templates/cursor/commands/create-pr.md- PR作成コマンドtemplates/cursor/commands/create-branch.md- ブランチ作成コマンド
その他のテンプレート
templates/cursor/prompts.mdc- Cursor用プロンプトtemplates/claude/custom-hooks.md- Claude用フックtemplates/agents/Agents.md- Agents設定
コマンドの使用方法
Cursorのチャットで / を入力すると、利用可能なコマンドが自動的に表示されます:
/create-pr- PR作成のワークフローを実行/create-branch- ブランチ作成のワークフローを実行
コマンドはプロジェクトの .cursor/commands ディレクトリに保存され、チーム全体で共有できます。
パッケージ配布
このパッケージは以下の2つの方法で配布されます:
1. GitHub Packages(Private)
- 対象: チーム内メンバーのみ
- パッケージ名:
@redamoon/ai-custom-template-prompt - レジストリ:
https://npm.pkg.github.com - 認証: GitHub Personal Access Token(PAT)が必要
セットアップ手順
GitHub Personal Access Tokenを作成
- 権限:
repo,write:packages,read:packages - Settings → Developer settings → Personal access tokens → Tokens (classic)
- 権限:
.npmrcファイルを作成@redamoon:registry=https://npm.pkg.github.com //npm.pkg.github.com/:_authToken=YOUR_PERSONAL_ACCESS_TOKENインストール
npm install @redamoon/ai-custom-template-prompt --registry=https://npm.pkg.github.com
2. Public npm
- 対象: 誰でも利用可能
- パッケージ名:
ai-custom-template-prompt - レジストリ:
https://registry.npmjs.org
インストール
npm install -g ai-custom-template-prompt自動公開
GitHub Actionsワークフローにより、タグを作成すると自動的に両方のレジストリに公開されます:
# バージョンタグを作成
git tag v0.1.0
git push origin v0.1.0必要なシークレット設定
GitHubリポジトリのSettings → Secrets and variables → Actionsに以下を設定:
NPM_TOKEN: npmjs.comのアクセストークン(Public npm公開用)- npmjs.comでログイン後、Access Tokensから作成
- 権限:
AutomationまたはPublish
ライセンス
MIT
