nexus

⚡ NEXUS CLI

A powerful, professional-grade, dynamic CLI devtool for scaffolding, managing, and stress testing Go backend systems.

Nexus CLI transforms the way you build Go backends. Instead of starting from scratch or fighting rigid boilerplates, Nexus provides an interactive TUI to scaffold a production-grade "Protocol Mesh" architecture tailored exactly to your needs. It supports REST, gRPC, GraphQL, WebSocket, and SSE—all routed through a unified middleware pipeline and served from a single handler function.

🚀 Installation

Option 1: Install via Go (Recommended)

If you have Go installed, you can easily install the latest stable version of the CLI directly. The version and build information will be embedded automatically:

go install github.com/Gamingstein/nexus/cmd/nexus@latest

Ensure that your $(go env GOPATH)/bin directory is in your system's $PATH.

Option 2: Pre-built Binaries

You can download the pre-compiled executable for macOS, Linux, or Windows directly from the GitHub Releases page. Simply download the executable for your platform, make it executable (chmod +x), and move it anywhere in your $PATH.

⏱️ Quick Start

Get a fully functioning, multi-protocol backend up and running in under a minute:

# 1. Initialize a new project using the interactive TUI
nexus init my-backend
cd my-backend

# 2. Add a new domain entity across all layers and protocols
nexus add entity User

# 3. Serve the generated project in development mode
nexus serve

🎥 Demo

(Replace YOUR_ASCIINEMA_ID with a real recording of the TUI in action)

🛠️ Command Reference

Nexus provides a comprehensive suite of commands to manage the entire lifecycle of your backend.

Run nexus help [command] for detailed usage instructions.

🏗️ Architecture Overview

Projects generated by Nexus CLI utilize a Protocol Mesh architecture. This design cleanly separates the transport layer (REST, gRPC, etc.) from the business logic, routing everything through a centralized, protocol-agnostic dispatcher.

graph TD
    subgraph "Protocol Adapters (Thin Translation Layer)"
        REST["REST (Fiber v3)"]
        GRPC["gRPC (HTTP/2)"]
        GQL["GraphQL"]
        WS["WebSocket"]
        SSE["SSE"]
    end

    subgraph "Mesh Engine (Protocol-Agnostic Core)"
        MW["Middleware Pipeline<br/>RequestID → Logger → Recover<br/>→ RateLimit → CORS → Cache → Timeout"]
        REG["Operation Registry"]
        DISP["Dispatcher"]
        EB["EventBus (Pub/Sub)"]
    end

    subgraph "Domain Layer (Clean Architecture)"
        SVC["Service Layer<br/>(Business Logic + DTOs)"]
        REPO_IF["Repository Interface"]
        ENT["Entity Layer<br/>(Structs + Validation)"]
    end

    subgraph "Infrastructure"
        MEM["InMemory Repo"]
        SQL["SQLite Repo"]
        LRU["LRU Cache"]
    end

    REST -->|"HTTP → MeshRequest"| DISP
    GRPC -->|"Protobuf → MeshRequest"| DISP
    GQL -->|"Query → MeshRequest"| DISP
    WS -->|"JSON msg → MeshRequest"| DISP
    SSE -->|"Subscribe"| EB

    DISP --> MW
    MW --> REG
    REG -->|"route to handler"| SVC
    SVC --> REPO_IF
    SVC -->|"domain events"| EB
    REPO_IF --> MEM
    REPO_IF --> SQL
    MW -.->|"cache reads"| LRU

    EB -->|"fan-out"| WS
    EB -->|"fan-out"| SSE

Key Concepts:

1. Protocol Adapters: Translate inbound requests (HTTP, Protobuf, JSON) into a unified MeshRequest.
2. Mesh Engine: Handles unified middleware (auth, logging, rate limiting) and dispatches requests based on an Operation Registry.
3. Domain & Infrastructure: Clean architecture with strict dependency inversion. Repositories are interfaces, implementations live in infrastructure.

📚 Documentation

For deep dives into the generated architecture, custom template authoring, and stress testing, check out the documentation:

• Architecture Reference
• Template Authoring Guide
• Stress Testing Guide

📜 License

Licensed under the Apache-2.0 License. See the LICENSE file for details.