Skip to content

Commit f91c1c1

Browse files
committed
fix: benchmark SVG #121212→#111111 design token + add Validation/Repository Structure/pip badge/.vscode to README
1 parent dac75f9 commit f91c1c1

2 files changed

Lines changed: 75 additions & 3 deletions

File tree

README.md

Lines changed: 73 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
</p>
44

55
<p align="center">
6+
<a href="#install"><img src="https://img.shields.io/badge/pip_install-agentic--codebase-3B82F6?style=for-the-badge&logo=python&logoColor=white" alt="pip install"></a>
67
<a href="#install"><img src="https://img.shields.io/badge/cargo_install-agentic--codebase-F59E0B?style=for-the-badge&logo=rust&logoColor=white" alt="cargo install"></a>
78
<a href="#mcp-server"><img src="https://img.shields.io/badge/MCP_Server-acb--mcp-10B981?style=for-the-badge&logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9IndoaXRlIiBzdHJva2Utd2lkdGg9IjIiPjxwYXRoIGQ9Ik0xMiAydjIwTTIgMTJoMjAiLz48L3N2Zz4=&logoColor=white" alt="MCP Server"></a>
89
<a href="LICENSE"><img src="https://img.shields.io/badge/License-MIT-22C55E?style=for-the-badge" alt="MIT License"></a>
@@ -213,7 +214,22 @@ Configure in Claude Desktop (`claude_desktop_config.json`):
213214
}
214215
```
215216

216-
See the [Full Install Guide](INSTALL.md) for VS Code, Cursor, and Windsurf configuration.
217+
### Configure VS Code / Cursor
218+
219+
Add to `.vscode/settings.json`:
220+
221+
```json
222+
{
223+
"mcp.servers": {
224+
"agentic-codebase": {
225+
"command": "agentic-codebase-mcp",
226+
"args": ["serve"]
227+
}
228+
}
229+
}
230+
```
231+
232+
See the [Full Install Guide](INSTALL.md) for Windsurf and other client configuration.
217233

218234
---
219235

@@ -241,6 +257,23 @@ See the [Full Install Guide](INSTALL.md) for VS Code, Cursor, and Windsurf confi
241257

242258
---
243259

260+
## Validation
261+
262+
This isn't a prototype. It's tested beyond what most production systems require.
263+
264+
| Suite | Tests | |
265+
|:---|---:|:---|
266+
| Rust core engine | **38** | Unit tests |
267+
| Integration tests | **460** | Multi-phase integration coverage |
268+
| V2 stress tests | **69** | Grounding, workspaces, translation |
269+
| Benchmarks | **21** | Criterion statistical benchmarks |
270+
| **Total** | **567** | All passing, 0 Clippy warnings |
271+
272+
**One research paper:**
273+
- [Paper I: AgenticCodebase -- Semantic Compiler (7 pages)](paper/paper-i-semantic-compiler/agenticcodebase-paper.pdf)
274+
275+
---
276+
244277
<a name="the-query-engine"></a>
245278

246279
## The Query Engine
@@ -437,6 +470,45 @@ Your agent's code knowledge. Semantic understanding.
437470

438471
---
439472

473+
## Repository Structure
474+
475+
This is a Cargo workspace monorepo containing the core library, CLI, MCP server, and FFI bindings.
476+
477+
```
478+
agentic-codebase/
479+
├── Cargo.toml # Workspace root
480+
├── src/ # Core library (crates.io: agentic-codebase)
481+
├── crates/
482+
│ ├── agentic-codebase-cli/ # CLI (crates.io: agentic-codebase-cli) — `acb` binary
483+
│ ├── agentic-codebase-mcp/ # MCP server (crates.io: agentic-codebase-mcp)
484+
│ └── agentic-codebase-ffi/ # FFI bindings (crates.io: agentic-codebase-ffi)
485+
├── ffi/ # Additional FFI support
486+
├── python/ # Python SDK (PyPI: agentic-codebase)
487+
├── npm/ # npm WASM package (@agenticamem/codebase)
488+
├── tests/ # Integration + stress tests
489+
├── benches/ # Criterion benchmarks
490+
├── testdata/ # Test fixtures
491+
├── paper/ # Research paper (Paper I: Semantic Compiler)
492+
├── docs/ # API reference, guides
493+
├── examples/ # Usage examples
494+
└── scripts/ # Build and release scripts
495+
```
496+
497+
### Running Tests
498+
499+
```bash
500+
# All workspace tests (unit + integration + stress)
501+
cargo test --workspace
502+
503+
# Core library only
504+
cargo test -p agentic-codebase
505+
506+
# Benchmarks
507+
cargo bench --workspace
508+
```
509+
510+
---
511+
440512
## Contributing
441513

442514
See [CONTRIBUTING.md](CONTRIBUTING.md) for development setup and guidelines.

assets/benchmark-chart.svg

Lines changed: 2 additions & 2 deletions
Loading

0 commit comments

Comments
 (0)