CLI Tool

The NestGo CLI provides powerful commands for project scaffolding, code generation, and development workflow.

Installation

go install github.com/nestgo/nestgo/cmd/nestgo@latest

Verify installation:

nestgo --version

Shell Autocompletion

Enable autocompletion for faster command entry:

Bash:

echo 'source <(nestgo completion bash)' >> ~/.bashrc
source ~/.bashrc

Zsh:

echo 'source <(nestgo completion zsh)' >> ~/.zshrc
source ~/.zshrc

Fish:

nestgo completion fish | source

Commands Overview

| Command | Description | |---------|-------------| | nestgo new | Create a new NestGo project | | nestgo dev | Start development server with hot-reload | | nestgo generate | Generate code (module, controller, service) | | nestgo doctor | Run diagnostics on your project | | nestgo graph | Visualize module dependencies | | nestgo lint-arch | Enforce Clean Architecture module boundaries | | nestgo routes | Display an AST-generated Route Explorer table | | nestgo docs:generate| Scaffold OpenAPI specs from code | | nestgo metrics | Display project health metrics | | nestgo build | Build for production |

new

Create a new NestGo project:

nestgo new my-api

Options:

• --package-manager - Choose package manager (go-modules, dep)
• --skip-git - Skip git initialization
• --template - Use a specific template (default, microservice, api)

Examples:

# Create with default settings
nestgo new my-api
 
# Create without git init
nestgo new my-api --skip-git
 
# Use microservice template
nestgo new my-api --template=microservice

dev

Start the development server with hot-reload:

nestgo dev

The server will start at http://localhost:8080.

generate

Generate code components:

Module

nestgo generate module products

Creates:

internal/products/
└── products.module.go

Controller

nestgo generate controller products

Service

nestgo generate service products

Resource (all-in-one)

nestgo generate resource products

Creates controller, service, DTO, and module.

doctor

Run diagnostics to check your project setup:

nestgo doctor

Checks:

• Go version compatibility
• Module dependencies
• Configuration validity
• Port availability

graph

Visualize module dependencies as a graph:

nestgo graph

Outputs a text-based diagram showing how modules depend on each other.

lint-arch

Enforce Clean Architecture boundaries by detecting illegal cross-module imports:

nestgo lint-arch

Returns exit code 1 if a module illegally imports domain logic from an isolated sibling module.

routes

Visualize all API endpoints currently defined in your controllers via AST inspection:

nestgo routes

Scans your codebase and outputs a beautiful terminal table showing Methods, Paths, and Summaries.

docs:generate

Automatically scaffold openapi.json from your existing NestGo AST route definitions:

nestgo docs:generate

metrics

Display key project metrics (number of controllers, services, lines of code, etc.):

nestgo metrics

build

Build for production:

nestgo build

Outputs binary to ./dist/.

Quick Reference

# Create project
nestgo new my-app
cd my-app
 
# Start development
nestgo dev
 
# Generate components
nestgo generate module users
nestgo generate controller users
nestgo generate service users
 
# Check setup
nestgo doctor
 
# View dependencies
nestgo graph
 
# Production build
nestgo build