Skip to content
Project Configuration

Configure Lurus Code for Your Project

Layered configuration with LURUS.md, settings, rules and hooks. Global defaults, project-specific overrides and environment variables - all perfectly orchestrated.

5 Configuration Layers
30+ Options
Hot Reload

Configuration Hierarchy

Each layer overrides the previous one. From global to environment - full control over every aspect.

1

Global Settings

~/.lurus/settings.json

User-wide settings that apply to all projects. API URL, default model, plugins and more.

2

Project Settings

.lurus/settings.json

Project-specific settings that override global ones. Permissions, hooks and MCP servers.

3

LURUS.md

LURUS.md

Project instructions in markdown. Describes architecture, conventions and workflows for the AI.

4

Rules

.lurus/rules/*.md

Modular rules with YAML frontmatter. Glob patterns, priorities and conditional activation.

5

Environment

LURUS_* env vars

Environment variables override all other settings. Ideal for CI/CD and secrets.

LURUS.md

Project Instructions in Markdown

The LURUS.md file is the heart of your project configuration. Here you describe architecture, conventions and workflows - the AI understands and follows them.

  • Document project architecture
  • Define coding conventions
  • Workflow descriptions
  • Important notes and warnings
  • @import for external files
LURUS.md
# Project: E-Commerce Platform

## Architecture
- Next.js 14 with App Router
- TypeScript strict mode
- Prisma ORM with PostgreSQL
- Tailwind CSS for styling

## Conventions
- Use Server Components by default
- Client Components only when needed
- All API routes in /app/api/
- Zod for validation

## Compact Instructions
When context is limited, focus on:
1. Type safety first
2. Server-side rendering
3. Prisma schema changes

## Workflow
1. Create feature branch
2. Write tests first (TDD)
3. Implement feature
4. Run `npm run lint && npm test`

@./docs/api-guidelines.md
@./docs/database-schema.md

All Configuration Options

Over 30 options for maximum control. In settings.json or as environment variable.

Models & API

apiUrl string

API endpoint

Default: https://api.lurus.ai
model string

Default model

Default: sonnet
fallbackModel string

Fallback on overload

utilityModel string

Model for internal tasks

Default: haiku
compactionModel string

Model for compaction

modelAliases object

Custom model aliases

Default: {}

Context & Tokens

maxTokens number

Max output tokens

contextBudget number

Token budget for context

Default: 15000
truncateToolOutput number

Truncate tool output

promptCaching boolean

Enable prompt caching

Default: true

Thinking & Effort

thinkingMode string

auto | adaptive | enabled | off

Default: auto
thinkingBudget number

Token budget for thinking

effort string

high | medium | low

maxMode boolean

Use full context window

Default: false

Automation

autoLint string|boolean

Auto-lint after changes

Default: false
autoTest string|boolean

Auto-test after changes

Default: false
autoTypeCheck string|boolean

Auto type check

Default: false
tddGuard string

off | warn | strict

Default: off

Costs & Limits

costWarningThreshold number

Warning at cost (EUR)

costLimit number

Hard cost limit (EUR)

Security

security.injectionScanner boolean

Injection scanner

Default: true
security.secretMasking boolean

Secret masking

Default: true
security.customPatterns string[]

Custom regex patterns

Default: []
disableBypassPermissions boolean

Disable bypass

Default: false
Rules System

Modular Rules with Frontmatter

Organize project rules in separate markdown files. YAML frontmatter for metadata, glob patterns and priorities.

YAML Frontmatter

Each rule file can contain metadata in YAML format: description, globs, alwaysApply and priority.

Glob Patterns

Rules can be restricted to specific file types: ["*.tsx", "src/components/**"]

Priorities

Higher priority = earlier in context. Important rules are loaded first.

Conditional Activation

alwaysApply: false - Rule is only activated for matching globs.

.lurus/rules/react-components.md
---
description: "React component conventions"
globs: ["*.tsx", "src/components/**"]
alwaysApply: false
priority: 10
---

# React Component Rules

## File Structure
- One component per file
- Use named exports
- Co-locate styles and tests

## Naming
- PascalCase for components
- camelCase for hooks
- Prefix hooks with "use"

## Props
- Define interface above component
- Use destructuring
- Provide default values

## State
- Prefer useState for simple state
- useReducer for complex state
- Avoid prop drilling — use context
MCP Servers

Model Context Protocol

Extend Lurus Code with external MCP servers. Filesystem, databases, APIs - everything integrable.

mcpServers in settings.json
{
  "filesystem": {
    "command": "npx",
    "args": [
      "-y",
      "@modelcontextprotocol/server-filesystem"
    ],
    "env": {
      "NODE_ENV": "production"
    },
    "cwd": "/path/to/project",
    "timeout": 30000,
    "trust": true,
    "includeTools": [
      "read_file",
      "write_file"
    ],
    "excludeTools": [
      "delete_file"
    ]
  }
}
Hooks System

Pre & Post Hooks

Automatically run commands before or after tool calls. Linting, formatting, tests - all automated.

hooks in settings.json
{
  "hooks": {
    "pre:Write": [
      {
        "matcher": "*.ts",
        "hooks": [
          {
            "type": "command",
            "command": "eslint --fix ${file}",
            "timeout": 10000
          }
        ]
      }
    ],
    "post:Bash": [
      {
        "hooks": [
          {
            "type": "command",
            "command": "echo 'Command completed'"
          }
        ]
      }
    ]
  }
}
Permissions

Configure Permissions

Define allowed and denied tools and commands. Project-specific or global - full control over the AI.

  • allow/deny for tools
  • allowedCommands for Bash
  • deniedCommands blocking
  • bashAutoApprove for CI/CD
permissions in settings.json
{
  "permissions": {
    "allow": [
      "Read",
      "Glob",
      "Grep"
    ],
    "deny": [
      "rm -rf",
      "sudo"
    ],
    "allowedCommands": [
      "npm test",
      "npm run build",
      "git status"
    ],
    "deniedCommands": [
      "rm -rf /",
      "chmod 777"
    ],
    "bashAutoApprove": false
  }
}

Manage Configuration

Slash commands for quick access

/config

Show current configuration

/rules

List loaded rules

/rules show <name>

Show rule content

/rules create

Create new rule

/init

Generate LURUS.md

/mcp

MCP server status

/mcp restart <name>

Restart MCP server

/model <name>

Switch model

/utilitymodel <name>

Set utility model

Early Access Now Available

Ready to revolutionize your development?

Thousands of developers already trust Lurus Code. Get started today.

No credit card required · GDPR Compliant · Hosted in Europe
Register for

Register for Launch

Be among the first to hear about Lurus Code. Exclusive early access and bonus features for early registrants.

✓ From €5/month✓ No Spam✓ Unsubscribe Anytime

We respect your privacy. Unsubscribe anytime.