Gorig

Gorig is a comprehensive web service framework based on the Go programming language. It provides a complete development model and toolchain. You can quickly create a new project or module using gorig-cli.

📚 Project Wiki: https://deepwiki.com/jom-io/gorig
🔧 Operations Dashboard: https://github.com/jom-io/gorig-om

Direct Installation

go get github.com/jom-io/gorig@latest

Using gorig-cli

Install globally via npm:

npm install -g gorig-cli

Or run directly using npx:

npx gorig-cli@latest <command>

You can also use npx directly without a global install for the common workflows below.

Quick Start

Initialize a New Project

Use the init command to create a new project:

gorig-cli init my-new-project

Or use npx:

npx gorig-cli@latest init my-new-project

This will create a new project in the current directory, including basic files and directories such as _cmd/main.go, domain/init.go, and cron/cron.go.

Create a New Module

Create a new module using the create command from the project's root directory:

gorig-cli create user

Or use npx:

npx gorig-cli@latest create user

This will create a module named user, including directories such as api/, internal/, model/, and essential boilerplate code.

Install Gorig Skill

The CLI also bundles the gorig-backend skill for Codex and Claude.

Install both user-level skills at once:

npx gorig-cli@latest skill install all

Install only the Codex skill:

npx gorig-cli@latest skill install codex

Install the Claude skill for your user account:

npx gorig-cli@latest skill install claude user

Install the Claude skill only for the current project:

npx gorig-cli@latest skill install claude project

Install locations:

• Codex: ${CODEX_HOME:-~/.codex}/skills/gorig-backend/
• Claude user-level: ~/.claude/skills/gorig-backend/
• Claude project-level: .claude/skills/gorig-backend/

After installation, the skill can be invoked by agents that support local skills and is intended for gorig backend implementation, API changes, tests, and module documentation work.

Running the Project

Navigate to your project directory and run the project using:

cd my-new-project
go run _cmd/main.go

Or compile and run:

go build -o my-new-project _cmd/main.go && ./my-new-project