Installation

Get started with Routix by installing the CLI tool or adding it as a library.

Routix provides a powerful CLI tool to help you scaffold projects and manage development. You can also use it purely as a library in your existing Go projects.

⚡ Quick Install (Recommended)

The easiest way to install the Routix CLI is using our installation script. This will download the correct binary for your system and set up your PATH automatically.

curl -sSL https://raw.githubusercontent.com/ramusaaa/routix/main/install.sh | bash

After installation, reload your shell:

source ~/.bashrc  # or ~/.zshrc for macOS

Verify the installation:

routix --version

📦 Go Install (Manual)

If you have Go installed, you can build the CLI directly from source:

go install github.com/ramusaaa/routix/cmd/routix@latest

Make sure your Go bin directory is in your system PATH ($HOME/go/bin).

📚 Use as a Library

If you prefer to start from scratch or integrate Routix into an existing project without the CLI, simply add the package:

go get github.com/ramusaaa/routix@latest

Then import it in your main.go:

import "github.com/ramusaaa/routix"

Create a New Project

Once you have the CLI installed, creating a new project is simple:

# Interactive setup
routix new my-awesome-api

Follow the prompts to select your database (PostgreSQL, MySQL, SQLite) and architecture preference.

Then enter your project and start the dev server:

cd my-awesome-api
go mod tidy
routix serve

Your server will be running at http://localhost:8080.