encore-getting-started

Encore.ts のセットアップ

手順

このガイドは Encore.ts 用です。Encore Go の場合は、encore-go-getting-started を使用してください。ユーザーが希望する言語を指定していない場合は、確認してください。

手順は順番に進めてください。各手順には、成功したかどうかを確認する方法が記載されています。手順に失敗した場合は、指定されたスキルを読み込んでください。

1. CLI を確認する

encore version

• encore version v... と表示される場合： 手順 2 に進みます。
• コマンドが見つからない場合： インストール（encore-install）してから、手順 2 に進みます。

2. ログインする

ユーザーがアプリをローカルで実行することだけを希望している場合は、この手順を省略してください。

encore auth whoami

• logged in as <email> と表示される場合： 手順 3 に進みます。
• not logged in. と表示される場合： encore auth login をバックグラウンドで開始します。表示されたペアリングコードと URL をユーザーに送り、任意のデバイスのブラウザーで承認するよう依頼します。Successfully logged in! が表示されるまで待ちます（encore-login）。
• logged in as app <app-id> と表示される場合、またはログインを承認できる人がいない場合（CI）： 認証キーではアプリを作成できません。Cloud Dashboard でアプリを作成してから、encore app clone <app-id> を実行し、そのディレクトリに cd して、手順 4 に進むようユーザーに依頼します。

3. アプリを作成する

encore app create my-app --example=ts/hello-world
cd my-app

• Successfully created app my-app! で終了する場合： 手順 4 に進みます。
• --example フラグはそのままにしてください。 ターミナルでは、言語とテンプレートの指定がない場合、CLI が尋ねます。通常エージェントがコマンドを実行する方法である、ターミナルを使わない場合は質問できず、代わりに空の Go アプリが作成されます。
• 空のアプリ： サービスのないアプリには、代わりに --example=ts/empty を使用し、手順 4 を省略してください。
• その他のテンプレートとエラー： encore-create-app を参照してください。

4. 実行できることを確認する

encore check 'curl /hello/world'

• {"message":"Hello world!"} と表示され、終了コード 0 で終了する場合： 手順 5 に進みます。
• 失敗する場合： encore-run を参照してください。

ユーザー向けにアプリを実行し続けるには、encore run をバックグラウンドで開始してください。フォアグラウンドでは実行しないでください（encore-run）。API は http://localhost:4000 にあり、すべてのリクエストのトレースを確認できるローカル開発ダッシュボードは http://localhost:9400 にあります。

5. Encore の MCP サーバーに接続する

MCP サーバーを使うと、アプリの構築中にアプリを調査して呼び出したり、Encore Cloud にデプロイした後にデプロイ内容を確認したりできます。ユーザーが --llm-rules=<tool> を指定してアプリを作成した場合、ローカルサーバーがそのツール用にすでに設定されていることがあります。追加する前に確認してください。

1. ローカルサーバー： アプリのルートディレクトリから encore mcp start を実行します。MCP stdio Command: encore mcp run --app=<app-id> が表示されます。そのコマンドをユーザーのツールに追加します。Claude Code の場合：

   claude mcp add --transport stdio encore-local -- encore mcp run --app=<app-id>
   

2. Encore Cloud サーバー（手順 2 でログインした場合のみ）：

   claude mcp add --transport http --scope user encore-cloud https://api.encore.dev/mcp
   

3. Cursor、VS Code、その他のツール、またはログインの代わりに API キーを使用する場合： encore-mcp を参照してください。

6. 結果を報告する

セットアップは完了です。ユーザーに次の内容を伝えてください。

• アプリの場所： アプリのディレクトリ、および Encore Cloud 上にある場合は Cloud Dashboard（https://app.encore.dev/<app-id>）。
• ユーザーに残っている作業： 再起動時に、ユーザーのツールが新しい MCP サーバーを読み込みます。encore-cloud を追加した場合は、一度認証する必要もあります。Claude Code では、/mcp を開き、encore-cloud を選択して、Authenticate を選びます。

アプリの開発を始めるには、作業に合ったスキルを読み込んでください。hello-world アプリには、hello/ に hello というサービスが 1 つあります。

内容	読み込むもの
エンドポイント、検証、エラーを追加する	encore-api
サービスを追加する、またはサービス間で呼び出す	encore-service
SQL データベースを追加する	encore-database
エンドポイントでログインを必須にする	encore-auth
Pub/Sub、cron ジョブ、バケット、シークレット、キャッシュを追加する	encore-pubsub、encore-cron、encore-bucket、encore-secret、encore-cache
テストを書く	encore-testing
デプロイする：コミットしてから git push encore を実行する	encore-deploy