Communitygithub.com

Jimartskenya/ai-code-context

🤖 Automatisiere die Codedokumentation mit KI, um das Verständnis zu verbessern und deinen Workflow zu optimieren – spare Zeit bei unbekannten Codebasen und Projekten.

Was ist ai-code-context?

Dieses Skill ermöglicht es Entwicklern, automatisch umfassende Kontextdokumentation für ihren Code zu generieren, indem KI eingesetzt wird. Es analysiert vorhandene Codebasen, extrahiert relevante Strukturen, Abhängigkeiten und Logik und erstellt eine klare, menschenlesbare Dokumentation. Dies ist besonders nützlich, wenn man in unbekannte Projekte eintaucht oder die Einarbeitungszeit für neue Teammitglieder verkürzen möchte. Das Tool lässt sich nahtlos in gängige Entwicklungsumgebungen integrieren und nutzt Large Language Models (LLMs), um Zusammenfassungen, Erklärungen und Kontextinformationen zu generieren. Es unterstützt eine Vielzahl von Programmiersprachen und Frameworks und bietet sowohl CLI- als auch API-Schnittstellen für flexible Nutzung. Durch die Automatisierung der Dokumentation reduziert es den manuellen Aufwand erheblich und stellt sicher, dass die Dokumentation stets aktuell und konsistent mit dem Code bleibt.

Funktioniert mit~Claude Code~Codex CLI~Cursor
npx skills add Jimartskenya/ai-code-context

In Ihrer bevorzugten KI fragen

Öffnet einen neuen Chat, in dem dieser Agent-Skill bereits geladen ist.

Dokumentation

Was macht ai-code-context?

🤖 Automatisiere die Codedokumentation mit KI, um das Verständnis zu verbessern und deinen Workflow zu optimieren – spare Zeit bei unbekannten Codebasen und Projekten.

Dieses Skill analysiert deine Codebasis, identifiziert Schlüsselkomponenten, Abhängigkeiten und Logik und generiert automatisch umfassende Dokumentation. Nutze die Leistungsfähigkeit von KI, um Kontext zu erhalten, ohne manuell durch jede Datei navigieren zu müssen.

Funktionen

  • Automatische Dokumentationsgenerierung: Erstelle Zusammenfassungen von Funktionen, Klassen, Modulen und ganzen Projekten.
  • Kontextanalyse: Verstehe, wie Komponenten interagieren und welche Abhängigkeiten bestehen.
  • Sprachunterstützung: Funktioniert mit den meisten gängigen Programmiersprachen (Python, JavaScript, TypeScript, Java, Go, Rust, C++ und mehr).
  • Plattformunabhängig: Kann als CLI-Tool, als Agenten-Skill (z. B. für Claude Code, Cursor, Codex) oder als API-Endpunkt verwendet werden.

Installation

Du kannst dieses Skill über deinen bevorzugten AI-Agenten installieren. Zum Beispiel:

# Für Claude Code
claude add skill jimartskenya/ai-code-context

# Oder manuell als Git-Submodul
cd .claude/skills
git https://github.com/Jimartskenya/ai-code-context

Verwendung

Sobald das Skill installiert ist, kannst du es mit einem Befehl wie diesem aufrufen:

ai-context --path /pfad/zum/projekt --output docs/README_AUTOGENERATED.md

Alternativ integrierst du es in deinen Workflow mit:

ai-context init

Beispielausgabe

# Projektübersicht

- **Sprache**: Python 3.11
- **Framework**: FastAPI
- **Wichtige Module**: 
  - `app/main.py` – Haupteinstiegspunkt
  - `app/models/` – Datenbankmodelle
  - `app/routes/` – API-Routen

## Abhängigkeiten

- FastAPI==0.104.1
- SQLAlchemy==2.0.23
- pydantic==2.4.2

Konfiguration

Du kannst das Verhalten über Umgebungsvariablen anpassen:

VariableBeschreibungStandard
AI_CONTEXT_MODELZu verwendendes KI-Modellgpt-4o
AI_CONTEXT_DEPTHTiefe der Analyse (1-5)3
AI_CONTEXT_FORMATAusgabeformatmarkdown

Lizenz

MIT

Verwandte Skills