rix-cli

rix is a CLI for generating AI project rule documents.

It helps new projects quickly create rule documents for AI coding tools, so the AI understands project boundaries, stack constraints, module generation order, and development rules before writing code.

What It Does

After running rix init, rix generates files based on your interactive choices:

• rix.config.json
• the rule document for the selected AI platform

AI platform output files:

| AI Platform | Output File | | --- | --- | | Claude Code | CLAUDE.md | | Codex | AGENTS.md | | Gemini | GEMINI.md |

How To Use

Run this in the target project directory:

rix init

Then select:

1. AI platform
2. Project category
3. Project template
4. Document language

The current directory name is used as the project name in the generated config.

Supported Categories

Currently supported:

• Backend
• Frontend
• Mobile
• Desktop

Supported Templates

Backend:

• Bun + Elysia Web API
• Go Gin Web API
• C# ASP.NET Web API
• Java Spring Boot Web API
• Python FastAPI Web API

Frontend:

• Vite + React Admin
• Vite + Vue Admin
• Next.js React Website
• Nuxt.js Vue Website

Mobile:

• Android Mobile
• iOS SwiftUI App
• Flutter App

Desktop:

• Tauri Desktop App
• Electron Desktop App

Common Options

Specify an output directory:

rix init --dir temp
rix init --dir ./l1/l2

Specify a language:

rix init --locale=zh-cn
rix init --locale=us-en

Overwrite existing generated files:

rix init --force

Generated Output

rix.config.json stores structured configuration, including project type, stack, architecture rules, output options, and module generation order.

The rule document stores AI-facing development boundaries, such as:

• Project identity
• Execution rules
• Code standards
• Project boundaries
• Stack rules
• Module generation order
• Architecture rules

One-line principle:

base controls flow, concrete templates control content, presets control default config, core controls generation behavior.