onerules

Stop your AI from writing slop.

One command generates anti-slop coding rules for 10 AI tools.
Auto-detects your stack. Works offline. Under 2 seconds.

简体中文

The Problem

AI coding tools generate slop: unnecessary abstractions, wrapper classes that wrap nothing, useMemo on everything, try/catch around code that can't throw, AbstractFactoryProviderManager classes, and 500-line files that should be 50.

onerules generates rules that specifically target these failure modes — for every AI tool you use, tuned to your framework.

What Makes This Different

These aren't generic "follow best practices" rules. Every rule targets a specific AI slop pattern:

# Instead of: "Avoid unnecessary abstractions"
# You get:

- DO NOT over-abstract. No AbstractFactoryProviderManager. No BaseServiceInterface.
  If the class name needs 3+ words to describe what it does, it's doing too much
  or too little.

- DO NOT create interfaces/types for a single implementation. Interface `IUserService`
  with one class `UserService` is pointless indirection.

- A function that wraps another function without adding behavior is not an
  abstraction — it's noise. Delete it.

- DO NOT install `axios`. The Fetch API is built-in, cached by Next.js, and has
  extended options. `axios` adds 14KB for nothing.

Quick Start

# Install globally (recommended)
npm i -g @blackforge/onerules

# Run in any project
onerules

Or without installing:

npx --package=@blackforge/onerules onerules

No API keys. No config. Works offline.

  onerules v0.3.0

  Detected: Next.js + TypeScript + Tailwind CSS + Prisma + pnpm

  Generated 10 files:
    ✓ CLAUDE.md                         (Claude Code)
    ✓ .cursor/rules/onerules.mdc        (Cursor)
    ✓ .github/copilot-instructions.md   (GitHub Copilot)
    ✓ AGENTS.md                         (OpenAI Codex)
    ✓ GEMINI.md                         (Gemini CLI)
    ✓ .windsurfrules                    (Windsurf)
    ✓ .clinerules                       (Cline)
    ✓ CONVENTIONS.md                    (Aider)
    ✓ .roo/rules/onerules.md            (Roo Code)
    ✓ .trae/rules/onerules.md           (Trae)

  Done in 1.2s

12 AI Tools, One Command

Features

• Anti-slop rules — every rule targets a specific AI code generation failure mode, not generic advice
• 12 AI tools — generates the correct file format for each tool
• 23 frameworks — deep rules for Next.js, React, Vue, Nuxt, Svelte, SvelteKit, Angular, Astro, Remix, Express, Fastify, Hono, FastAPI, Django, Flask, Rails, Gin, Fiber, Actix, Axum, Tauri, Electron, React Native
• Custom rules — add a .onerulesrc file with your own rules that survive onerules update
• Gitignore aware — warns if generated files are in your .gitignore
• Zero-config — auto-detects stack from package.json, pyproject.toml, go.mod, Cargo.toml, or Gemfile
• No LLM required — deterministic, fast (<2s), works completely offline
• Safe by default — skips existing files unless you use --force

Supported Stacks

Languages: TypeScript, JavaScript, Python, Go, Rust, Ruby

Frameworks (with anti-slop rules): Next.js, React, Vue, Nuxt, Svelte, SvelteKit, Angular, Astro, Remix, Express, Fastify, Hono, FastAPI, Django, Flask, Rails, Gin, Fiber, Actix, Axum, Tauri, Electron, React Native

Tooling: pnpm, yarn, bun, npm, uv, poetry, pip, cargo, bundler | Vitest, Jest, Playwright, Cypress, pytest, RSpec | ESLint, Biome, Ruff, RuboCop | Prettier, dprint, Black

Commands

onerules                         # Generate for all 10 tools
onerules -t claude,cursor        # Generate for specific tools only
onerules --force                 # Overwrite existing files
onerules --dry-run               # Preview without writing
onerules -d ./my-project         # Specify project directory
onerules update                  # Re-detect and regenerate all files
onerules diff                    # Show what would be generated

Custom Rules (.onerulesrc)

Add a .onerulesrc file to your project root to add custom rules that get merged into all generated files. Survives onerules update.

{
  "projectContext": "This is a fintech app handling real money.",
  "principles": ["Always explain your reasoning before writing code."],
  "doNot": ["DO NOT use any ORM. Write raw SQL queries.", "DO NOT use floating point for money. Use integers (cents)."],
  "security": ["All endpoints require authentication. No public endpoints."]
}

Example Rules

Here's a taste of what gets generated for a Next.js + TypeScript project:

## Do Not

- DO NOT add `'use client'` to a component just because it receives props
  or renders conditionally. Server Components can do both.
- DO NOT use `useEffect(() => { fetch('/api/...') }, [])` for data loading.
  Use a Server Component with async/await.
- DO NOT create API routes for operations that should be Server Actions.
  If a client component needs to mutate data, use a server action.
- DO NOT install `axios`. The Fetch API is built-in, cached by Next.js,
  and has extended options.

## Coding Patterns

- Inline simple logic. A 3-line helper called once is worse than 3 lines
  at the call site.
- Three similar lines are better than a premature abstraction. Do not DRY
  code until a pattern has repeated 3+ times with identical structure.
- Use discriminated unions over class hierarchies.
  `type Shape = Circle | Square` over `abstract class Shape`.

FAQ

Does this replace my existing CLAUDE.md? No. By default, onerules skips files that already exist. Use --force to overwrite.

Does this call any AI APIs? No. Fully deterministic. Works offline. No API keys needed.

Can I customize the generated rules? Yes. Edit the generated files after running onerules. They're plain markdown.

How is this different from awesome-cursorrules or Karpathy's CLAUDE.md? Those are single files for one tool. onerules generates rules for 10 tools simultaneously, tuned to your specific framework, with anti-slop rules that target AI failure modes specifically.

Contributing

We welcome contributions! The easiest ways:

1. Improve rules — make the anti-slop rules sharper for any framework
2. Add a framework — create a fragment in src/templates/fragments/
3. Add a tool — create a generator in src/generate/

See CONTRIBUTING.md for details.

License

MIT