Features

• Automatische Dokumentation – Generiert Markdown aus Code
• Signatur-Validierung – Prüft Konsistenz zwischen Code und Docs
• Drift-Detection – Erkennt veraltete Dokumentation
• Impact-Analyse – Analysiert Auswirkungen von Änderungen
• Cursor-Integration – Rules und MCP-Server für AI-Agenten

Installation

# Global
npm install -g @noyrax/cli

# Als Dev-Dependency
npm install -D @noyrax/cli

Quick Start

1. Projekt initialisieren

npx noyrax init

Dies erstellt:

• noyrax.config.json – Konfiguration
• .cursor/rules/ – Agent-Rules (optional)
• .cursor/mcp.json – MCP-Server-Konfiguration (optional)

2. Dokumentation generieren

npx noyrax generate

3. Validieren

npx noyrax validate

CLI Commands

noyrax init

Initialisiert ein Projekt.

npx noyrax init [options]

Options:
  -f, --force       Bestehende Konfiguration überschreiben
  --with-rules      Cursor Rules installieren
  -v, --verbose     Ausführliche Ausgabe

noyrax generate

Generiert Dokumentation.

npx noyrax generate [options]

Options:
  -i, --incremental  Nur geänderte Dateien verarbeiten
  -w, --watch        Watch-Modus
  -v, --verbose      Ausführliche Ausgabe

noyrax validate

Validiert die Dokumentation.

npx noyrax validate [options]

Options:
  --strict           Warnings als Errors behandeln
  -v, --verbose      Ausführliche Ausgabe

noyrax drift

Prüft auf Drift.

npx noyrax drift [options]

Options:
  --since <commit>   Prüft seit einem bestimmten Commit (default: HEAD~1)

noyrax impact

Analysiert Auswirkungen einer Änderung.

npx noyrax impact <file> [symbol]

Cursor Integration

Rules

Noyrax liefert vorgefertigte .cursor/rules/:

| Rule | Beschreibung | |------|--------------| | 000-orchestrator.mdc | Zentrale Workflow-Steuerung | | 001-pre-check.mdc | Pflichtschritte vor Änderungen | | 020-validate-workflow.mdc | Validierungs-Workflow | | 021-impact-analysis.mdc | Impact-Analyse | | 030-constraints.mdc | Architektur-Constraints |

MCP-Server

Der MCP-Server ermöglicht strukturierte AI-Agent-Kommunikation:

// .cursor/mcp.json
{
  "mcpServers": {
    "noyrax": {
      "command": "noyrax-mcp",
      "args": ["start"]
    }
  }
}

Verfügbare Tools:

| Tool | Beschreibung | |------|--------------| | validation/runScan | Projekt scannen | | validation/runValidate | Dokumentation validieren | | validation/runDriftCheck | Drift erkennen | | validation/analyzeImpact | Impact-Analyse |

Programmatic API

import { 
  initProject, 
  generateDocs,
  validateDocs,
  checkDrift 
} from '@noyrax/cli';

// Projekt initialisieren
await initProject({
  targetDir: './my-project',
  withRules: true,
});

// Dokumentation generieren
const result = await generateDocs({
  incremental: true,
});

// Validieren
const validation = await validateDocs({
  strict: true,
});

// Drift prüfen
const drift = await checkDrift({
  since: 'HEAD~5',
});

Konfiguration

noyrax.config.json

{
  "include": ["src/**/*.ts"],
  "exclude": ["**/*.test.ts", "node_modules/**"],
  "output": {
    "modules": "docs/modules",
    "system": "docs/system",
    "index": "docs/index"
  },
  "validation": {
    "coverage": {
      "classes": 0.9,
      "functions": 0.8
    },
    "blockOnDrift": false
  }
}

Links

• Noyrax Website
• VS Code Extension
• GitHub Repository
• Documentation

License

MIT © Benjamin Behrens