analyze-codebase-workflow
关于
This skill automatically analyzes any codebase to detect workflows, data pipelines, and file dependencies using putior's `put_auto()` engine. It generates an annotation plan by mapping detected I/O patterns to source files across 30+ languages with 902 auto-detection patterns. Use it to explore an unfamiliar codebase, start putior integration in an unannotated project, or audit a data pipeline before documentation.
快速安装
Claude Code
推荐npx skills add pjt222/agent-almanac -a claude-code/plugin add https://github.com/pjt222/agent-almanacgit clone https://github.com/pjt222/agent-almanac.git ~/.claude/skills/analyze-codebase-workflow在 Claude Code 中复制并粘贴此命令以安装该技能
技能文档
name: analyze-codebase-workflow description: > Eine beliebige Codebase analysieren, um Workflows, Datenpipelines und Dateiabhängigkeiten mit putiors put_auto()-Engine automatisch zu erkennen. Erzeugt einen Annotationsplan, der erkannte I/O-Muster Quelldateien über 30+ unterstützte Sprachen mit 902 Auto-Erkennungsmustern zuordnet. Verwenden, wenn eine unbekannte Codebase erkundet werden soll, putior-Integration in einem Projekt ohne Annotationen gestartet wird oder die Datenpipeline vor der Dokumentation auditiert werden soll. license: MIT locale: de source_locale: en source_commit: 6f65f316 translator: claude-opus-4-6 translation_date: 2026-03-16 allowed-tools: Read Write Edit Bash Grep Glob metadata: author: Philipp Thoss version: "1.0" domain: workflow-visualization complexity: intermediate language: multi tags: putior, workflow, analysis, auto-detect, polyglot, data-pipeline
Codebase-Workflow analysieren
Ein beliebiges Repository analysieren, um Datenflüsse, Datei-I/O und Skript-Abhängigkeiten automatisch zu erkennen, dann einen strukturierten Annotationsplan zur manuellen Verfeinerung erzeugen.
Wann verwenden
- Einarbeitung in eine unbekannte Codebase, um Datenflüsse zu verstehen
- putior-Integration in einem Projekt ohne PUT-Annotationen starten
- Vorhandene Datenpipeline eines Projekts vor der Dokumentation auditieren
- Annotationsplan vorbereiten vor Ausführung von
annotate-source-files
Eingaben
- Erforderlich: Pfad zum Repository oder Quellverzeichnis zum Analysieren
- Optional: Spezifische Unterverzeichnisse zum Fokussieren (Standard: gesamtes Repo)
- Optional: Sprachen zum Ein- oder Ausschließen (Standard: alle erkannten)
- Optional: Erkennungsumfang: nur Inputs, nur Outputs oder beides (Standard: beides + Abhängigkeiten)
Vorgehensweise
Schritt 1: Repository-Struktur erkunden
Quelldateien und ihre Sprachen identifizieren, um zu verstehen, was putior analysieren kann.
library(putior)
# Alle unterstützten Sprachen und ihre Erweiterungen auflisten
list_supported_languages()
list_supported_languages(detection_only = TRUE) # Nur Sprachen mit Auto-Erkennung
# Unterstützte Erweiterungen abrufen
exts <- get_supported_extensions()
Dateiauflistung zum Verstehen der Repo-Zusammensetzung verwenden:
# Dateien nach Erweiterung im Zielverzeichnis zählen
find /path/to/repo -type f | sed 's/.*\.//' | sort | uniq -c | sort -rn | head -20
Erwartet: Liste der im Repo vorhandenen Dateiendungen mit Anzahlen. Diese gegen get_supported_extensions() abgleichen, um Abdeckung zu kennen.
Bei Fehler: Wenn das Repo keine Dateien mit unterstützten Erweiterungen hat, kann putior keine Workflows auto-erkennen. Überlegen, ob die Sprache unterstützt wird, aber Dateien nicht-standardmäßige Erweiterungen verwenden.
Schritt 2: Spracherkennungsabdeckung prüfen
Für jede erkannte Sprache die Verfügbarkeit von Auto-Erkennungsmustern verifizieren.
# Prüfen welche Sprachen Auto-Erkennungsmuster haben (18 Sprachen, 902 Muster)
detection_langs <- list_supported_languages(detection_only = TRUE)
cat("Sprachen mit Auto-Erkennung:\n")
print(detection_langs)
# Musterzahlen für spezifische im Repo gefundene Sprachen abrufen
for (lang in c("r", "python", "javascript", "sql", "dockerfile", "makefile")) {
patterns <- get_detection_patterns(lang)
cat(sprintf("%s: %d Input-, %d Output-, %d Abhängigkeitsmuster\n",
lang,
length(patterns$input),
length(patterns$output),
length(patterns$dependency)
))
}
Erwartet: Musterzahlen für jede Sprache ausgegeben. R hat 124 Muster, Python 159, JavaScript 71 usw.
Bei Fehler: Wenn eine Sprache keine Muster zurückgibt, unterstützt sie manuelle Annotationen aber keine Auto-Erkennung. Diese Dateien manuell annotieren planen.
Schritt 3: Auto-Erkennung ausführen
put_auto() auf das Zielverzeichnis ausführen, um Workflow-Elemente zu entdecken.
# Vollständige Auto-Erkennung
workflow <- put_auto("./src/",
detect_inputs = TRUE,
detect_outputs = TRUE,
detect_dependencies = TRUE
)
# Build-Skripte und Test-Helfer vom Scan ausschließen
workflow <- put_auto("./src/",
detect_inputs = TRUE,
detect_outputs = TRUE,
detect_dependencies = TRUE,
exclude = c("build-", "test_helper")
)
# Erkannte Workflow-Knoten anzeigen
print(workflow)
# Knotenanzahl prüfen
cat(sprintf("Erkannte %d Workflow-Knoten\n", nrow(workflow)))
Für große Repos, Unterverzeichnisse schrittweise analysieren:
# Spezifische Unterverzeichnisse analysieren
etl_workflow <- put_auto("./src/etl/")
api_workflow <- put_auto("./src/api/")
Erwartet: Ein DataFrame mit Spalten id, label, input, output, source_file. Jede Zeile repräsentiert einen erkannten Workflow-Schritt.
Bei Fehler: Wenn das Ergebnis leer ist, enthalten die Quelldateien möglicherweise keine erkennbaren I/O-Muster. Debug-Logging aktivieren: workflow <- put_auto("./src/", log_level = "DEBUG"), um zu sehen, welche Dateien gescannt und welche Muster zugeordnet werden.
Schritt 4: Initialdiagramm generieren
Den automatisch erkannten Workflow visualisieren, um Abdeckung zu beurteilen und Lücken zu identifizieren.
# Diagramm aus auto-erkanntem Workflow generieren
cat(put_diagram(workflow, theme = "github"))
# Mit Quelldatei-Info für Nachverfolgbarkeit
cat(put_diagram(workflow, show_source_info = TRUE))
# Zur Überprüfung in Datei speichern
writeLines(put_diagram(workflow, theme = "github"), "workflow-auto.md")
Erwartet: Mermaid-Flowchart mit erkannten Knoten, verbunden durch Datenfluss-Kanten. Knoten sollten mit aussagekräftigen Funktions-/Dateinamen beschriftet sein.
Bei Fehler: Wenn das Diagramm getrennte Knoten zeigt, hat die Auto-Erkennung I/O-Muster gefunden, konnte aber keine Verbindungen ableiten. Das ist normal — Verbindungen werden aus übereinstimmenden Output-Dateinamen mit Input-Dateinamen abgeleitet. Der Annotationsplan (nächster Schritt) adressiert Lücken.
Schritt 5: Annotationsplan erstellen
Einen strukturierten Plan erstellen, der Gefundenes und manuell Anzunotierendes dokumentiert.
# Annotationsvorschläge generieren
put_generate("./src/", style = "single")
# Mehrzeiliger Stil (lesbarer für komplexe Workflows)
put_generate("./src/", style = "multiline")
# Vorschläge in die Zwischenablage kopieren
put_generate("./src/", output = "clipboard")
Plan mit Abdeckungsbewertung dokumentieren:
## Annotationsplan
### Auto-erkannt (kein manueller Aufwand nötig)
- `src/etl/extract.R` — 3 Inputs, 2 Outputs erkannt
- `src/etl/transform.py` — 1 Input, 1 Output erkannt
### Braucht manuelle Annotation
- `src/api/handler.js` — Sprache unterstützt, aber keine I/O-Muster zugeordnet
- `src/config/setup.sh` — Nur 12 Shell-Muster; komplexe Logik nicht erfasst
### Nicht unterstützt
- `src/legacy/process.f90` — Fortran nicht in Erkennungssprachen
### Empfohlene Verbindungen
- extract.R-Output `data.csv` → transform.py-Input `data.csv` (auto-verknüpft)
- transform.py-Output `clean.parquet` → load.R-Input (Annotation erforderlich)
Erwartet: Klarer Plan, der auto-erkannte Dateien von manuell zu annotierenden trennt, mit spezifischen Empfehlungen für jede Datei.
Bei Fehler: Wenn put_generate() keine Ausgabe erzeugt, sicherstellen, dass der Verzeichnispfad korrekt ist und Quelldateien in unterstützten Sprachen enthält.
Validierung
-
put_auto()wird ohne Fehler auf das Zielverzeichnis ausgeführt - Erkannter Workflow hat mindestens einen Knoten (außer das Repo hat kein erkennbares I/O)
-
put_diagram()erzeugt gültigen Mermaid-Code aus dem auto-erkannten Workflow -
put_generate()erzeugt Annotationsvorschläge für Dateien mit erkannten Mustern - Annotationsplan-Dokument mit Abdeckungsbewertung erstellt
Haeufige Stolperfallen
- Zu breit scannen:
put_auto(".")auf einem Repo-Root einzuführen kannnode_modules/,.git/,venv/usw. einschließen. Spezifische Quellverzeichnisse anvisieren. - Vollständige Abdeckung erwarten: Auto-Erkennung findet Datei-I/O und Bibliotheksaufrufe, nicht Geschäftslogik. Eine Abdeckungsrate von 40-60 % ist typisch; der Rest benötigt manuelle Annotation.
- Abhängigkeiten ignorieren: Das Flag
detect_dependencies = TRUEerfasstsource(),import,require()-Aufrufe, die Skripte miteinander verknüpfen. Deaktivieren verliert dateiübergreifende Verbindungen. - Sprachabweichung: Dateien mit nicht-standardmäßigen Erweiterungen (z. B.
.Rvs.r,.jsxvs.js) werden möglicherweise nicht erkannt.get_comment_prefix()verwenden, um zu prüfen ob eine Erweiterung erkannt wird. - Große Repos: Für Repos mit 100+ Quelldateien nach Modul/Verzeichnis analysieren, um Diagramme lesbar zu halten.
Verwandte Skills
install-putior— Voraussetzung: putior muss zuerst installiert werdenannotate-source-files— nächster Schritt: manuelle Annotationen basierend auf dem Plan hinzufügengenerate-workflow-diagram— endgültiges Diagramm nach Abschluss der Annotation generierenconfigure-putior-mcp— MCP-Tools für interaktive Analysesitzungen verwenden
GitHub 仓库
相关推荐技能
executing-plans
设计该Skill用于当开发者提供完整实施计划时,以受控批次方式执行代码实现。它会先审阅计划并提出疑问,然后分批次执行任务(默认每批3个任务),并在批次间暂停等待审查。关键特性包括分批次执行、内置检查点和架构师审查机制,确保复杂系统实现的可控性。
requesting-code-review
设计该Skill可在完成任务、实现主要功能或合并代码前自动调度代码审查子代理,确保实现符合需求和计划。它支持通过指定git SHA范围进行精准的代码变更审查,帮助开发者在关键节点及时发现潜在问题。核心原则是"早审查、勤审查",适用于开发流程的各个关键阶段。
connect-mcp-server
设计这个Skill指导开发者如何将MCP服务器连接到Claude Code,支持HTTP、stdio和SSE三种传输协议。它涵盖了从安装配置到认证安全的完整流程,适用于集成GitHub、Notion、数据库等外部服务。当开发者需要添加集成、配置外部工具或提及MCP相关功能时,这个Skill能提供实用的操作指南。
web-cli-teleport
设计该Skill帮助开发者根据任务特性选择Claude Code的Web或CLI界面,并指导如何在两种环境间无缝迁移会话。它能分析任务复杂度、迭代需求等要素,推荐最优工作界面和工作流。关键特性包括会话状态管理、环境切换指导和上下文优化建议。
