Skip to main content
skill CX Codex

encore-getting-started — Claude Code skill: set up Encore.ts

encore-getting-started walks through Encore.ts setup from scratch: installs the CLI, creates an app, checks that it runs, and connects Encore's MCP servers.

Apache-2.0 727 installs ★ 30 updated 2026-10-23

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add encoredev/skills --skill encore-getting-started -a claude-code
Open on GitHub

What encore-getting-started does

The skill runs six steps: checks encore version, installs the CLI if needed, logs in via encore auth login, creates an app with encore app create --example=ts/hello-world, verifies it with encore check, connects local and cloud MCP servers, and reports where the project lives. Each step checks the result and hands off to a narrower skill if something fails.

Requires Node.js. Without a terminal, the CLI creates an empty Go app instead of TypeScript, so the --example flag is mandatory. Once setup completes, the skill suggests loading encore-api, encore-service, or other skills to add endpoints, databases, and deploys.

What it helps with

  • install Encore.ts CLI and create a first app
  • verify the app runs locally
  • connect Encore MCP servers to Claude Code or Cursor
  • log in to Encore Cloud with encore auth login
  • set up a hello-world project with one service

Example prompts for the agent

  • Set up Encore.ts from scratch: install the CLI, create an app, and connect MCP servers
  • Check if the Encore CLI is installed and create a hello-world project
  • Log in to Encore Cloud and start the local dev server

How to install encore-getting-started

1Skills CLI (Vercel)

npx skills add encoredev/skills --skill encore-getting-started -a claude-code

2Manually: put the files in place

~/.claude/skills/getting-started/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/getting-started/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about encore-getting-started

How to install encore-getting-started in Claude Code?

Run npx skills add encoredev/skills --skill encore-getting-started -a claude-code. The skill appears in ~/.claude/skills/getting-started/SKILL.md.

What does encore-getting-started do?

The skill automates Encore.ts setup: installs the CLI, creates an app with an example, checks that it runs, and connects MCP servers for working with the project through an agent.

When do I need encore-getting-started?

When you have no Encore project yet and want to start from scratch. If a project already exists and you're asking about architecture or features, use encore-service, encore-api, or other skills.

Source text

SKILL.md · Apache-2.0
---
name: encore-getting-started
description: Set up Encore.ts from scratch. Install the CLI, log in, create an app, check that it runs, and connect Encore's MCP servers, with a pointer to the skill for each step. Ends where building starts. Not for architecture or feature questions.
when_to_use: >-
  User has no Encore project yet and wants to get set up with Encore.ts end to end: install the CLI, log in, create a hello-world app, check that it runs, and connect Encore's MCP servers. For a single step, use `encore-install`, `encore-login`, `encore-create-app`, `encore-run`, or `encore-mcp`. SKIP if the user already has an Encore project and is asking about architecture, services, endpoints, or specific features. Those go to `encore-service`, `encore-api`, `encore-pubsub`, etc. Trigger phrases: "set up Encore", "completely new to Encore", "first time", "get started with Encore", "hello world", "just starting out".
---

# Setting Up Encore.ts

## Instructions

This guide is for Encore.ts. For Encore Go, use `encore-go-getting-started`. If the user hasn't said which language they want, ask.

Do the steps in order. Each step says how to tell it worked. If a step fails, load the skill it names.

### 1. Check the CLI

```bash
encore version
```

- **Prints `encore version v...`:** go to step 2.
- **Command not found:** install it (`encore-install`), then go to step 2.

### 2. Log in

Skip this step if the user only wants to run the app locally.

```bash
encore auth whoami
```

- **`logged in as <email>`:** go to step 3.
- **`not logged in.`:** start `encore auth login` in the background. Send the user the pairing code and URL it prints, and ask them to approve it in a browser on any device. Wait for `Successfully logged in!` (`encore-login`).
- **`logged in as app <app-id>`, or no person can approve a login (CI):** an auth key can't create apps. Ask the user to create the app in the Cloud Dashboard, then run `encore app clone <app-id>`, `cd` into it, and go to step 4.

### 3. Create the app

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

- **Ends with `Successfully created app my-app!`:** go to step 4.
- **Keep the `--example` flag.** In a terminal, the CLI asks for a language and template when it's missing. Without a terminal, which is how agents usually run commands, it can't ask, and creates an empty Go app instead.
- **Empty app:** for an app with no services, use `--example=ts/empty` instead, and skip step 4.
- **Other templates and errors:** see `encore-create-app`.

### 4. Check that it runs

```bash
encore check 'curl /hello/world'
```

- **Prints `{"message":"Hello world!"}` and exits 0:** go to step 5.
- **Fails:** see `encore-run`.

To keep the app running for the user, start `encore run` in the background, never in the foreground (`encore-run`). The API is at `http://localhost:4000`, and the local development dashboard, with a trace of every request, is at `http://localhost:9400`.

### 5. Connect Encore's MCP servers

The MCP servers let you inspect and call the app while you build it, and read its deploys once it's on Encore Cloud. If the user created the app with `--llm-rules=<tool>`, the local server may already be configured for that tool: check before adding it again.

1. **Local server:** from the app's root directory, run `encore mcp start`. It prints `MCP stdio Command: encore mcp run --app=<app-id>`. Add that command to the user's tool. In Claude Code:

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

2. **Encore Cloud server** (only if you logged in at step 2):

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

3. **Cursor, VS Code, other tools, or an API key instead of signing in:** see `encore-mcp`.

### 6. Report back

Setup is done. Tell the user:

- **Where the app is:** its directory, and, if it's on Encore Cloud, its Cloud Dashboard at `https://app.encore.dev/<app-id>`.
- **What's left for them:** their tool loads the new MCP servers when it restarts. If you added `encore-cloud`, they also need to authenticate it once: in Claude Code, `/mcp`, select `encore-cloud`, and choose **Authenticate**.

To build on the app, load the skill for the task. The hello-world app has one service, `hello`, in `hello/`.

| To | Load |
|----|------|
| Add endpoints, validation, and errors | `encore-api` |
| Add services or call one service from another | `encore-service` |
| Add a SQL database | `encore-database` |
| Require login on endpoints | `encore-auth` |
| Add Pub/Sub, cron jobs, buckets, secrets, or caching | `encore-pubsub`, `encore-cron`, `encore-bucket`, `encore-secret`, `encore-cache` |
| Write tests | `encore-testing` |
| Deploy: commit, then `git push encore` | `encore-deploy` |

© encoredev · Apache-2.0 · encoredev/skills

Similar skills

All skills for Backend and APIs →

From the same set31

The whole set →
encore-database encore-database teaches the AI agent to manage PostgreSQL in Encore.ts applications. It guides schema migrations and typed SQL queries using SQLDatabase. CX Codex +1 858installs encore-testing encore-testing guides your agent through writing and running automated tests for Encore.ts with encore test and vitest or jest. Useful when an endpoint or service needs coverage without hand-rolling test databases. CX Codex +1 846installs encore-frontend encore-frontend — a skill that connects React, Next.js, Vue or Svelte apps to an Encore.ts backend: typed client generation, CORS setup and auth tokens. CX Codex +1 821installs encore-migrate encore-migrate guides step-by-step backend migrations to Encore.ts or Encore Go. It tracks progress via migration-plan.md, separates backend APIs from frontend code, and supports an autonomous mode. CX Codex +1 782installs encore-go-auth The encore-go-auth skill helps secure Encore Go endpoints and identify callers. Use it for JWTs, API keys, bearer tokens, or session cookies. CX Codex +1 613installs encore-go-testing encore-go-testing is a Claude Code skill for writing and running Encore Go tests with encore test and Go’s standard testing package. It covers APIs, services, databases, and errors. CX Codex +1 612installs encore-go-service This skill structures Encore.go services, Go packages, systems, and typed calls between services. Use it when adding a service or applying an agreed layout. CX Codex +1 611installs encore-go-api encore-go-api teaches the agent to write Encore Go endpoints with the //encore:api annotation: typed request and response structs, path, query, header and cookie params, error codes. CX Codex +1 611installs

Project sponsors

Companies that keep this analytics open