ContextQMD
Back to Go Micro

Getting Started

internal/website/docs/getting-started.md

5.19.16.2 KB
Original Source

Getting Started

Go Micro provides two ways to get started: the CLI (recommended) or manual setup.

Development Workflow

Go Micro has a clear lifecycle for development through deployment:

StageCommandPurpose
Developmicro runLocal dev with hot reload and API gateway
Buildmicro buildCompile production binaries
Deploymicro deployPush to a remote Linux server via SSH + systemd
Dashboardmicro serverOptional production web UI with auth

Quick Start (CLI)

Install the CLI:

bash
go install go-micro.dev/v5/cmd/[email protected]

Note: Use a specific version instead of @latest to avoid module path conflicts. See releases for the latest version.

Create and run a service:

bash
micro new helloworld
cd helloworld
micro run

Open http://localhost:8080 to see your service and call it from the browser.

The gateway proxies HTTP to RPC:

bash
curl -X POST http://localhost:8080/api/helloworld/Helloworld.Call \
  -H "Content-Type: application/json" \
  -d '{"name": "World"}'

micro run gives you:

  • Web Dashboard at http://localhost:8080
  • Agent Playground at http://localhost:8080/agent — AI chat with MCP tools
  • API Explorer at http://localhost:8080/api — browse endpoints and schemas
  • API Gateway at http://localhost:8080/api/{service}/{method}
  • MCP Tools at http://localhost:8080/api/mcp/tools — services exposed as AI tools
  • Hot Reload — auto-rebuild on file changes
  • Health Checks at http://localhost:8080/health

See the micro run guide for configuration, multi-service projects, and more.

Manual Setup (Framework Only)

If you prefer to set up a service without the CLI:

bash
go get go-micro.dev/v5@latest

Create a service

This is a basic example of how you'd create a service and register a handler in pure Go.

bash
mkdir helloworld
cd helloworld
go mod init
go get go-micro.dev/v5@latest

Write the following into main.go

go
package main

import (
        "go-micro.dev/v5"
)

type Request struct {
        Name string `json:"name"`
}

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

type Say struct{}

func (h *Say) Hello(ctx context.Context, req *Request, rsp *Response) error {
        rsp.Message = "Hello " + req.Name
        return nil
}

func main() {
        // create the service
        service := micro.New("helloworld")

        // initialise service
        service.Init()

        // register handler
        service.Handle(new(Say))

        // run the service
        service.Run()
}

Now run the service

bash
go run main.go

Take a note of the address with the log line

text
Transport [http] Listening on [::]:35823

Now you can call the service

bash
curl -XPOST \
     -H 'Content-Type: application/json' \
     -H 'Micro-Endpoint: Say.Hello' \
     -d '{"name": "alice"}' \
      http://localhost:35823

Set a fixed address

To set a fixed address, pass it as an option:

go
service := micro.New("helloworld", micro.Address(":8080"))

Alternatively use MICRO_SERVER_ADDRESS=:8080 as an env var

bash
curl -XPOST \
     -H 'Content-Type: application/json' \
     -H 'Micro-Endpoint: Say.Hello' \
     -d '{"name": "alice"}' \
      http://localhost:8080

Protobuf

If you want to define services with protobuf you can use protoc-gen-micro (go-micro.dev/v5/cmd/protoc-gen-micro).

Install the generator:

bash
go install go-micro.dev/v5/cmd/[email protected]

Note: Use a specific version instead of @latest to avoid module path conflicts. See releases for the latest version.

bash
cd helloworld
mkdir proto

Edit a file proto/helloworld.proto

proto
syntax = "proto3";

package greeter;
option go_package = "/proto;helloworld";

service Say {
        rpc Hello(Request) returns (Response) {}
}

message Request {
        string name = 1;
}

message Response {
        string message = 1;
}

You can now generate a client/server like so (ensure $GOBIN is on your $PATH so protoc can find protoc-gen-micro):

bash
protoc --proto_path=. --micro_out=. --go_out=. helloworld.proto

In your main.go update the code to reference the generated code

go
package main

import (
        "go-micro.dev/v5"

        pb "github.com/micro/helloworld/proto"
)

type Say struct{}

func (h *Say) Hello(ctx context.Context, req *pb.Request, rsp *pb.Response) error {
        rsp.Message = "Hello " + req.Name
        return nil
}

func main() {
        // create the service
        service := micro.New("helloworld")

        // initialise service
        service.Init()

        // register handler
        pb.RegisterSayHandler(service.Server(), &Say{})

        // run the service
        service.Run()
}

Now I can run this again

bash
go run main.go

Call via a client

The generated code provides us a client

go
package main

import (
        "context"
        "fmt"

        "go-micro.dev/v5"
        pb "github.com/micro/helloworld/proto"
)

func main() {
        service := micro.New("helloworld")
        service.Init()

        say := pb.NewSayService("helloworld", service.Client())

        rsp, err := say.Hello(context.TODO(), &pb.Request{
            Name: "John",
        })
        if err != nil {
                fmt.Println(err)
                return
        }

        fmt.Println(rsp.Message)
}

Command Line

Install the Micro CLI:

go install go-micro.dev/v5/cmd/[email protected]

Note: Use a specific version instead of @latest to avoid module path conflicts. See releases for the latest version.

Call a running service via RPC:

micro call helloworld Say.Hello '{"name": "John"}'

Alternative using the dynamic CLI commands:

micro helloworld say hello --name="John"

Next Steps