Getting Started with Encore Go Instructions Install Encore CLI

macOS

brew install encoredev/tap/encore

Linux/WSL

curl -L https://encore.dev/install.sh | bash

Windows (PowerShell)

iwr https://encore.dev/install.ps1 | iex

Create a New App

Interactive - choose from templates

encore app create my-app

Or start with a blank Go app

encore app create my-app --example=hello-world

Project Structure

A minimal Encore Go app:

my-app/ ├── encore.app # App configuration ├── go.mod # Go module └── hello/ # A service (package with API) └── hello.go # API endpoints

The encore.app File // encore.app { "id": "my-app" }

This file marks the root of your Encore app. The id is your app's unique identifier.

Create Your First API

In Encore Go, any package with an //encore:api endpoint becomes a service:

// hello/hello.go package hello

import "context"

type Response struct { Message string json:"message" }

//encore:api public method=GET path=/hello func Hello(ctx context.Context) (*Response, error) { return &Response{Message: "Hello, World!"}, nil }

Run Your App

Start the development server

encore run

Your API is now available at http://localhost:4000

Open the Local Dashboard

Opens the local development dashboard

encore run

Then visit http://localhost:9400

The dashboard shows:

All your services and endpoints Request/response logs Database queries Traces and spans Common CLI Commands Command Description encore run Start the local development server encore test Run tests (uses go test under the hood) encore db shell Open a psql shell to a database encore gen client Generate API client code encore app link Link to an existing Encore Cloud app Add Path Parameters type GetUserParams struct { ID string }

type User struct { ID string json:"id" Name string json:"name" }

//encore:api public method=GET path=/users/:id func GetUser(ctx context.Context, params GetUserParams) (User, error) { return &User{ID: params.ID, Name: "John"}, nil }

Add a Database // db.go package hello

import "encore.dev/storage/sqldb"

var db = sqldb.NewDatabase("mydb", sqldb.DatabaseConfig{ Migrations: "./migrations", })

Create a migration:

-- hello/migrations/1_create_table.up.sql CREATE TABLE items ( id SERIAL PRIMARY KEY, name TEXT NOT NULL );

Query the Database import "encore.dev/storage/sqldb"

type Item struct { ID int Name string }

func getItem(ctx context.Context, id int) (*Item, error) { item, err := sqldb.QueryRowItem if err != nil { return nil, err } return item, nil }

Next Steps Add more endpoints (see encore-go-api skill) Add authentication (see encore-go-auth skill) Add infrastructure like Pub/Sub, cron jobs (see encore-go-infrastructure skill) Deploy to Encore Cloud: encore app link then git push encore