Skip to main content
skill CX Codex

encore-go-getting-started — Claude Code skill for Encore Go setup

encore-go-getting-started guides a fresh Encore Go setup, from checking the CLI to running a hello-world app and connecting MCP servers. Use it when starting a project from scratch.

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

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

What encore-go-getting-started does

The skill walks through checking Encore CLI, signing in, and creating an app from the hello-world template. It then runs encore check 'curl /hello/world' and connects the local MCP server. An Encore Cloud server can be added after sign-in. Each step includes a way to verify the result.

You can skip sign-in when you only want to run the app locally. In CI, an auth key cannot create apps, so create one in the Cloud Dashboard and clone it with encore app clone <app-id>. The local MCP command comes from running encore mcp start in the app directory. This guide stops at setup; service and API work belongs to other skills.

What it helps with

  • check whether Encore CLI is installed
  • create an Encore Go app from the hello-world template
  • verify that the local app responds
  • connect local and Encore Cloud MCP servers

Example prompts for the agent

  • Set up Encore Go from scratch and run a hello-world app.
  • Create an Encore Go app, test /hello/world, and connect its MCP servers.
  • I'm working in CI; walk me through creating and setting up an Encore Go app.

How to install encore-go-getting-started

1Skills CLI (Vercel)

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

2Manually: put the files in place

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

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

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

Questions about encore-go-getting-started

How do I install encore-go-getting-started in Claude Code?

Run npx skills add encoredev/skills --skill encore-go-getting-started -a claude-code, then npx skills add encoredev/skills --skill go-getting-started -a claude-code. The skill file is at ~/.claude/skills/go-getting-started/SKILL.md.

What does encore-go-getting-started do?

It guides the initial Encore Go setup: CLI check, sign-in, app creation, a local run check, and MCP connections. Other skills cover work on APIs, services, and app features.

Can I use it without signing in?

Yes, when you only want to run the app locally. In CI, create the app in the Cloud Dashboard and run encore app clone <app-id>; an auth key cannot create apps.

Source text

SKILL.md · Apache-2.0
---
name: encore-go-getting-started
description: Set up Encore Go 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 Go end to end: install the CLI, log in, create a hello-world Go 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 Go project and is asking about architecture, services, endpoints, or specific features. Those go to `encore-go-service`, `encore-go-api`, `encore-go-pubsub`, etc. Trigger phrases: "set up Encore Go", "completely new to Encore", "first time", "get started with Encore Go", "hello world Go", "just starting out".
---

# Setting Up Encore Go

## Instructions

This guide is for Encore Go. For Encore.ts, use `encore-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=hello-world
cd my-app
```

- **Ends with `Successfully created app my-app!`:** go to step 4.
- **Empty app:** for an app with no services, use `--example=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-go-api` |
| Add services or call one service from another | `encore-go-service` |
| Add a SQL database | `encore-go-database` |
| Require login on endpoints | `encore-go-auth` |
| Add Pub/Sub, cron jobs, buckets, secrets, or caching | `encore-go-pubsub`, `encore-go-cron`, `encore-go-bucket`, `encore-go-secret`, `encore-go-cache` |
| Write tests | `encore-go-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-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 encore-go-database encore-go-database guides SQL queries, schema migrations, and PostgreSQL setup in Encore Go services using the sqldb package. CX Codex +1 609installs encore-go-code-review encore-go-code-review — a skill that scans existing Encore Go code for anti-patterns: infrastructure inside functions, missing context, SQL injection risks before you merge. CX Codex +1 609installs encore-secret The encore-secret skill manages API keys and other private values in Encore.ts. It helps agents declare, read, and set secrets for separate environments. CX Codex +1 477installs encore-cron encore-cron guides agents in setting up periodic background tasks in Encore.ts with CronJob. Useful for nightly cleanup, scheduled reports, and batch jobs. CX Codex +1 476installs encore-pubsub The encore-pubsub skill guides asynchronous messaging in Encore.ts with Topic and Subscription, including fan-out events and background consumers. CX Codex +1 474installs encore-bucket encore-bucket is a Claude Code skill that teaches agents to use Bucket from encore.dev/storage/objects for file uploads, downloads, signed URLs, and typed permission references. CX Codex +1 474installs

Project sponsors

Companies that keep this analytics open