gokub

README

GOKUB

Build a solid Go service without rebuilding the foundation.
Guided setup, clean architecture, production defaults, and AI-ready workflows.

GOKUB creates Go applications through a friendly terminal wizard. Pick a project style, framework, database, messaging provider, and Go version; GOKUB generates ordinary Go code that your team fully owns.

You choose                         GOKUB prepares
--------------------------------  -------------------------------------
Monolith or microservices         Clean, domain-focused project layout
Gin, Fiber, gRPC, or net/http     Secure HTTP lifecycle and health checks
PostgreSQL, MongoDB, messaging    Ready-to-wire platform adapters
Go 1.26, 1.25, or custom          Matching go.mod, Docker, and CI versions
Developer and AI workflows        IDE debug, agent skills, and MCP config

Install

The installer supports macOS and Linux on Intel and ARM:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/ongyoo/gokub/main/install.sh)"

Or use your preferred package manager:

# Homebrew
brew install ongyoo/tap/gokub

# Go
go install github.com/ongyoo/gokub/cmd/gokub@latest

Verify the installation:

gokub version

Generated projects require a Go toolchain matching the version selected in the wizard. New projects default to Go 1.26, with Go 1.25 available as the conservative baseline.

Create Your First Project

Start the wizard:

gokub new

Use Up/Down to move, Enter to select, and press Enter on a text field to accept the recommended value. No long command is required.

Project name      example-api
Go module         github.com/example/example-api
Go version        1.26 (recommended)
Project style     monolith
Template          monolith
Framework         gin
Database          postgres
Architecture      clean
Messaging         none
Recipe            none

Run the generated service:

cd example-api
go test ./...
go run ./cmd/example-api

The project already includes Docker, GitHub Actions, VS Code and JetBrains debug configuration, health checks, tests, agent guidance, and local environment examples.

Everyday Workflows

Run gokub inside a generated project for a context-aware command menu, or use commands directly:

Goal	Command
Add a CRUD domain	gokub add crud product
Generate models from JSON	gokub add model user --from user.json
Add authentication	gokub add auth
Enable Kafka	gokub enable messaging kafka
Switch to RabbitMQ	gokub switch messaging rabbitmq
Apply an event-driven stack	gokub recipe add event-driven
Inspect project capabilities	gokub status
Check project health	gokub doctor
Run the quality gate	gokub score --fail-under 80
Check architecture boundaries	gokub graph --check

Discover every command without leaving the terminal:

gokub help
gokub help new
gokub help add

Templates That Fit Your Team

Use the included monolith or microservices foundation, a focused template such as gin-clean, fiber-clean, worker, or grpc-service, or import any local project folder as a reusable team template:

gokub template add team-api ./path/to/example-project
gokub template list
gokub new

Custom templates support placeholders such as {{project_name}}, {{module}}, and {{go_version}}. GOKUB excludes Git metadata, secrets, caches, dependencies, and build output when importing a folder.

Built For Developers And AI

Every generated project includes shared context for humans and coding agents:

• VS Code and GoLand/IntelliJ run and debug configurations
• AGENTS.md, CLAUDE.md, Gemini, and GitHub Copilot instructions
• Portable skills for Codex, Claude, Copilot, Gemini, and compatible agents
• .codex/config.toml and .mcp.json for MCP clients
• Machine-readable status, doctor, score, and graph output

Install or refresh agent skills in any GOKUB project:

gokub skill install
gokub agent init
gokub mcp serve

MCP mode uses clean JSON-RPC output, so the terminal logo never pollutes the protocol stream.

Install the VS Code extension from the latest release:

curl -fL https://github.com/ongyoo/gokub/releases/latest/download/gokub-vscode.vsix \
  -o gokub-vscode.vsix
code --install-extension gokub-vscode.vsix

Automation

Interactive use is the default, but every project choice is also scriptable:

gokub new payments \
  --module github.com/example/payments \
  --go-version 1.26 \
  --style monolith \
  --framework gin \
  --database postgres \
  --recipe api

JSON output is available for CI and agents:

gokub status --json
gokub doctor --json
gokub score --json
gokub graph --format json

Update And Uninstall

gokub update --check
gokub update
gokub uninstall

For Homebrew installations, use brew upgrade gokub and brew uninstall gokub so Homebrew keeps its package state consistent.

Documentation

Guide	What you will find
Getting started	Installation, project creation, and first run
CLI reference	Commands, features, capabilities, and recipes
Project templates	Monolith, microservices, stack, and defaults
Go version policy	Recommended, conservative, and custom versions
Custom templates	Turn a local folder into a reusable template
JSON model generator	Generate typed Go models from JSON or JSON Schema
AI and IDE integrations	Codex, Claude, Copilot, MCP, VS Code, and JetBrains
Full documentation	Upgrades, plugins, skills, development, and releases

Platform Support

Platform	Intel	ARM
macOS	Yes	Yes
Linux	Yes	Yes

GOKUB is available under the MIT License. Contributions, templates, recipes, providers, plugins, and skill packs are welcome.

---

Powered by Roomkub
roomkub.thailand@gmail.com

Documentation

Index

• Variables

Variables

var (
	Version    = "0.1.0"
	Repository = "ongyoo/gokub"
	Commit     = "dev"
	BuildDate  = "unknown"
)

Version and Repository are replaced by release builds.

var Assets embed.FS

Assets embeds files required by generated projects and agent integrations.