Quick start

import { Steps } from ‘@astrojs/starlight/components’;

Create a Go application with Nx, then run, test, and build it using targets that gonx infers from go.mod.

Before you start

Node.js 20+ and an Nx 23.x workspace
Go — a stable release (1.18+ for multi-module workspaces)

gonx 3.x targets Nx 23.x:

Nx version	gonx version
23.x	3.x

Steps

1. **Create a workspace with the gonx preset** ```bash npx create-nx-workspace go-workspace --preset=@naxodev/gonx ``` This scaffolds an Nx workspace with gonx registered and a starter Go project. If you already have a workspace, install gonx into it instead: ```bash npx nx add @naxodev/gonx ```

Create a Go application
```
cd go-workspace
npx nx g @naxodev/gonx:application my-go-app
```
The generator creates a Go project with a package main entry point. gonx detects the go.mod and infers build, serve, test, lint, tidy, and generate targets. Pass --template to choose standard, cli, or tui. See the application generator guide for all options.
Run the application
```
npx nx serve my-go-app
```
The serve target runs go run from the project root. See the serve executor guide.
Test the project
```
npx nx test my-go-app
```
The test target runs go test. See the test executor guide.
Build the project
```
npx nx build my-go-app
```
The build target compiles an executable. See the build executor guide.

Verify

List the projects Nx detected and the targets inferred for your application:

npx nx show projects
npx nx show project my-go-app

nx show project lists the build, serve, test, lint, tidy, and generate targets with no project.json file. Run npx nx build my-go-app a second time to confirm caching — the second run is served from the Nx cache.

Next steps

Create your first Go project — a full walkthrough with explanations
Install GoNx — add gonx to an existing workspace
Plugin options — customize target names and tags
Migrate to gonx 3.0.0 — coming from nx-go