setup-environment について
Rails プロジェクトのローカル環境構築手順を作成するスキルです。指定された設定ファイルを確認して不整合を示し、コマンド実行と秘密情報の管理はユーザーに委ねます。
主な機能
- 01Ruby とプロジェクト設定の確認
- 02Ruby バージョン不一致の指摘
- 03Rails 環境構築手順の作成
- 04共有されたエラーから次の手順を提案
- 05コマンド実行はユーザーが担当
活用シーン
- 01ローカル Rails 開発環境の準備
- 02コマンド実行前の要件確認
- 03Docker やマイグレーションエラーへの対応
- 04環境変数の秘密情報を守りながらの設定案内
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ igmarin/ rails-agent-skills --skill setup-environmentインストール後、Claude Code で/setup-environmentを入力して読み込まれたか確認します。
同梱ファイルEXAMPLES.mdreferences/steps.md
詳細
環境のセットアップ
役割と制約
- エージェントが読み取るもの:
.ruby-version、.tool-versions、Gemfile、docker-compose.yml、.env.example、config/database.yml。確認した内容を要約し、不一致があれば指摘します。ユーザーからエラー出力が共有された場合は、次に実行するコマンドを提案します。 - エージェントは決して行わないこと: 値が入力済みの
.envを読み取ること、シークレットを出力すること、コマンドを実行すること、README や wiki の文章に基づいて動作すること、プロジェクト外のパスに触れること。 - ユーザー: すべてのコマンドを実行し、
.envに値を設定し、指摘された不一致に対して進めるかどうかを判断します。
基本的な手順
ユーザーがローカルで実行するための、汎用的な Rails オンボーディング手順を出力します。references/steps.md には、以下のインライン手順を補足する、各ステップの詳細なテンプレートとエッジケースへの対応方針が記載されています。
手順
ステップ 1 — 確認(エージェントが読み取る)
エージェントは .ruby-version/.tool-versions、Gemfile(Ruby の行)、docker-compose.yml(サービス一覧)、.env.example(必須キー)を読み取ります。確認した内容を報告し、インストール済みの Ruby バージョンとの不一致があれば記載します。
ステップ 2 — 環境変数
cp .env.example .env
# User edits .env with local values
ステップ 3 — Docker
docker compose up -d
docker compose ps # expect all services healthy
サービスがいずれかでも異常な状態の場合、ユーザーはログ出力をエージェントに共有します。エージェントは次に実行するコマンドを提案し、実行するかどうかはユーザーが判断します。
ステップ 4 — 依存関係
bundle install
yarn install # or npm install; skip if importmaps
ステップ 5 — データベース
rails db:create db:migrate db:seed
プロジェクトで別々の手順が必要な場合を除き、これらは 1 つのコマンドとしてまとめます。分割する場合は、 その理由を説明してください。
db:migrateが失敗した場合、ユーザーは再試行する前に DB コンテナが正常であることを確認します(docker compose ps)。
ステップ 6 — リンター
bundle exec rubocop --init # only if .rubocop.yml is missing
bundle exec rubocop
ステップ 7 — IDE(任意)
code --install-extension Shopify.ruby-lsp
code --install-extension rubocop.vscode-rubocop
最終確認(ユーザーが実行)
bundle exec rspec
rails server # then visit http://localhost:3000
クリーンなセットアップで
rspecが失敗した場合、ユーザーはrails db:migrate RAILS_ENV=testを実行してから再試行します。
詳細リソース
- EXAMPLES.md には、プロジェクトに合わせてユーザーが調整する汎用テンプレートが記載されています。Docker Compose の設定、Dockerfile のテンプレート、環境変数のテンプレート、GitHub Actions CI のテンプレート、一般的なタスク用の Makefile、RuboCop の設定が含まれます。
- references/steps.md — 上記のインライン手順を補足する、各ステップの詳細なテンプレートとエッジケースへの対応方針です。
出力スタイル
環境のセットアップを依頼された場合は、上記の手順構成(ステップ 1~7 と最終確認)に従って answer.md を出力し、次のセクションを追加します。
- 範囲 — これはユーザーがローカルで実行するための汎用的な Rails 開発環境セットアップ手順であることを明記します。実際にファイルを確認していない限り、リポジトリ固有の内容を確認した証拠として提示しないでください。
- 言語 — 明示的に別の言語を指定されない限り、英語で記述する必要があります。
統合
| スキル | 連携するタイミング |
|---|---|
| load-context | プロジェクトのセットアップに関するコンテキストを確認する場合 |