Skip to content

Commit 0b04fe4

Browse files
update readme
1 parent c41221a commit 0b04fe4

1 file changed

Lines changed: 30 additions & 19 deletions

File tree

README.md

Lines changed: 30 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -58,16 +58,20 @@ Forget about exporting API keys every time. Run the setup wizard to securely sto
5858
codilay setup
5959
```
6060

61-
```bash
62-
codilay
63-
```
64-
65-
Running `codilay` with no arguments opens the **Interactive Control Center**, allowing you to manage projects, configure providers, and launch scans without memorizing flags.
61+
Running `codilay` with no arguments opens the **Interactive Control Center**, a premium terminal-based dashboard that lets you manage projects, configurations, and audits without memorizing flags.
6662

6763
---
6864

6965
## 🛠 Features
7066

67+
### 🎮 Interactive Control Center (Terminal Dashboard)
68+
Why use flags when you can have a full-blown dashboard in your terminal?
69+
- **Project Switcher**: Quickly jump between documented codebases.
70+
- **Provider Wizard**: Configure keys and models with real-time validation.
71+
- **Live Monitoring**: Track active scans and resource usage.
72+
- **Audit Console**: Launch security and architecture scans from a central menu.
73+
- **History Browser**: View past conversations and export logs.
74+
7175
### 🧠 The Wire Model
7276
CodiLay treats every import, function call, and variable reference as a **Wire**.
7377
- **Open Wires**: Unresolved references that the agent is "hunting" for.
@@ -92,18 +96,20 @@ Ask questions about your codebase using `codilay chat .`.
9296
- **Memory**: The agent remembers your preferences and facts about the codebase across sessions.
9397
- **Promote to Doc**: Found a great explanation in chat? Use `/promote` to turn the AI's answer into a permanent section of your documentation.
9498

95-
### 🌐 Web Documentation Browser
96-
The Web UI isn't just a reader—it's an interactive intelligence layer.
97-
- **Layer 1: The Reader**: High-fidelity rendering of your sections and graph.
98-
- **Layer 2: The Chatbot**: Quick Q&A from documented context.
99-
- **Layer 3: The Deep Agent**: Reaches into source code to verify facts.
100-
10199
```bash
102100
codilay serve .
103101
```
104102

105-
### 👁 Watch Mode
106-
Run CodiLay in the background and automatically update documentation when files change. Uses filesystem events (via watchdog) with configurable debouncing to avoid redundant re-runs.
103+
- **Layer 1: The Reader**: High-fidelity rendering of your sections and graph.
104+
- **Layer 2: The Chatbot**: Quick Q&A from documented context.
105+
- **Layer 3: The Deep Agent**: Reaches into source code to verify facts.
106+
- **Layer 4: Audit Lab**: Browse past audit reports and run new ones directly from the web interface.
107+
108+
### 👁 Watch Mode & Real-time Progress
109+
Run CodiLay in the background and automatically update documentation when files change.
110+
- **Debounced Watcher**: Uses filesystem events (via watchdog) to auto-update on save.
111+
- **Real-time Progress Display**: High-resolution progress bars for file processing, triage, and LLM calls.
112+
- **Eager Resolution**: Wires are closed the moment a file is processed, giving you instant graph feedback.
107113

108114
```bash
109115
# Watch the current directory, auto-update on save
@@ -331,26 +337,31 @@ codilay schedule stop .
331337
codilay schedule disable .
332338
```
333339

334-
### 🛡️ System Audits
335-
Run AI-powered audits against your architecture, security, performance, and code quality. Passive mode uses existing context (fast), while active mode deeply inspects files (thorough). Supports 48 different types of audits.
340+
### 🛡️ System Audits (Architecture & Security)
341+
Run AI-powered audits against your architecture, security, performance, and code quality. Passive mode uses existing context (fast), while active mode deeply inspects files (thorough).
342+
343+
CodiLay supports **60+ different audit types**, including:
344+
- **Security**: XSS, Auth flows, Secrets, Crypto, Container/Cloud security, Pentest.
345+
- **Architecture**: Scalability, Caching, DB Efficiency, API Boundaries.
346+
- **Quality**: Readability, Chaos Engineering, Reliability, SEO.
347+
- **Compliance**: GDPR, License violations, Data Governance.
336348

337349
```bash
338350
# Run a passive security audit
339351
codilay audit . --type security --mode passive
340352

341353
# Run an active architecture audit
342354
codilay audit . --type architecture --mode active
343-
344-
# Audits can also be run from the Interactive Menu or Web UI
345355
```
356+
Audits can be managed and viewed from the **CLI**, the **Interactive Menu**, or the **Web UI**.
346357

347358
---
348359

349360
## ⌨️ CLI Reference
350361

351362
| Command | Action |
352363
|:---|:---|
353-
| `codilay` | Launch the **Interactive Menu** |
364+
| `codilay` | Launch the **Interactive Control Center** |
354365
| `codilay .` | Document the current directory (incremental) |
355366
| `codilay chat .` | Start a **Chat session** about the project |
356367
| `codilay serve .` | Launch the **Web UI** |
@@ -368,7 +379,7 @@ codilay audit . --type architecture --mode active
368379
| `codilay team` | Manage shared team knowledge (facts/decisions/conventions) |
369380
| `codilay search . "query"` | Full-text search across all past conversations |
370381
| `codilay schedule` | Configure and run scheduled doc updates (set/start/stop) |
371-
| `codilay audit .` | Run an automated codebase audit (48 types) |
382+
| `codilay audit .` | Run automated codebase audits (60+ types) |
372383

373384
---
374385

0 commit comments

Comments
 (0)