Skip to content

Commit d39af43

Browse files
committed
docs: update README to reflect current repo structure
1 parent 5a04cb6 commit d39af43

1 file changed

Lines changed: 21 additions & 12 deletions

File tree

  • agents/Mathews-Tom__codebase-auditor
Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# codebase-auditor
22

3-
Unified multi-dimensional codebase quality assessment agent that spawns parallel review agents, complements with architecture and dependency analysis, and produces a prioritized report. Covers security, performance, maintainability, and correctness in a single pass.
3+
Multi-dimensional codebase quality assessment agent that orchestrates specialized reviewers in parallel — code quality, security vulnerabilities, secret detection, architecture integrity, and dependency health — and synthesizes findings into a single deduplicated, severity-ranked report with a binary PASS/FAIL verdict.
44

55
## Run
66

@@ -10,23 +10,32 @@ npx @open-gitagent/gitagent run -r https://github.com/Mathews-Tom/codebase-audit
1010

1111
## What It Can Do
1212

13-
- Run parallel quality assessments across security, performance, and maintainability dimensions
14-
- Analyze architecture patterns and identify structural anti-patterns
15-
- Audit dependency health, licensing, and vulnerability exposure
16-
- Generate prioritized findings with severity ratings and remediation guidance
17-
- Produce executive summaries and detailed technical reports
18-
- Support pre-release audit workflows and compliance checks
13+
- **Scope Analysis** — determines audit scope from changed files, direct dependencies, or full repository inventory
14+
- **Parallel Agent Spawning** — runs code quality, security, and secret detection reviews concurrently
15+
- **Architecture Review** — assesses structural integrity, module boundaries, coupling, and scalability patterns
16+
- **Dependency Audit** — checks for CVEs, license compliance, abandoned packages, and dependency bloat
17+
- **Aggregation and Deduplication** — merges overlapping findings, preserves highest severity, eliminates report noise
18+
- **Verdict Determination** — binary PASS (zero CRITICAL/HIGH) or FAIL with prioritized action items
1919

2020
## Structure
2121

2222
```
2323
codebase-auditor/
24-
agent.yaml # Agent configuration and tool definitions
25-
SOUL.md # Agent personality and behavioral guidelines
26-
icon.png # 256x256 agent icon
27-
banner.png # 1200x630 agent banner
24+
├── .gitignore
25+
├── LICENSE
26+
├── README.md
27+
├── RULES.md
28+
├── SOUL.md
29+
├── agent.yaml
30+
├── assets/
31+
│ ├── icon.png
32+
│ └── banner.png
33+
└── knowledge/
34+
├── audit-dimensions.md
35+
├── report-template.md
36+
└── severity-classification.md
2837
```
2938

3039
## Built with
3140

32-
[gitagent](https://github.com/open-gitagent/gitagent) - the open agent registry and runner.
41+
Built for the [gitagent](https://gitagent.sh) ecosystem.

0 commit comments

Comments
 (0)