Skip to content

Commit f04635d

Browse files
committed
docs: update README to v8.5 agent integration and CLI docs
1 parent 61c47c6 commit f04635d

1 file changed

Lines changed: 17 additions & 11 deletions

File tree

README.md

Lines changed: 17 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# 🧠 BBC — Bitter Brain Context v8.4
1+
# 🧠 BBC — Bitter Brain Context v8.5
22

33
> **Zero-Hallucination AI Coding Framework** — Analyzes your project, detects your active IDE, and provides AI assistants with a verified sealed context.
44
55
[![Python](https://img.shields.io/badge/python-3.8%2B-blue)](https://www.python.org/)
66
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
7-
[![Version](https://img.shields.io/badge/version-v8.4%20STABLE-green)](https://github.com/Anubis44197/BBC)
7+
[![Version](https://img.shields.io/badge/version-v8.5%20STABLE-green)](https://github.com/Anubis44197/BBC)
88

99
---
1010

@@ -155,13 +155,19 @@ BBC's daemon (`bbc_daemon.py`) actively monitors your project for changes every
155155

156156
The daemon uses `adaptive_mode.check_context_freshness()` for hash-based staleness detection and recommends `RESCAN` or `PARTIAL_RESCAN` based on the ratio of changed files.
157157

158-
### 🧠 Adaptive Mode (STRICT / RELAXED)
159-
BBC operates in two modes depending on context match quality:
158+
### � Agent Integration Layer (v8.5)
159+
BBC now exposes its operational mode directly to AI agents through the sealed context and injected instruction files.
160160

161-
| Mode | Trigger | Behavior |
162-
|---|---|---|
163-
| **STRICT** | `context_match_ratio ≥ 0.8` | AI only uses verified symbols from `.bbc/bbc_context.json` |
164-
| **RELAXED** | `context_match_ratio < 0.8` | AI may use broader knowledge with a hallucination warning |
161+
- **Versioning / Compatibility**`bbc_instructions_version` and `context_schema_version` are written into `.bbc/bbc_context.json` and `BBC_INSTRUCTIONS.md`
162+
- **Freshness Gate**`context_fresh` tracks whether the current context still matches the project on disk
163+
- **Fail Policy**`fail_closed` blocks code generation on stale or missing context, while `fail_open` allows continuation with a warning
164+
- **Enforcement Profiles**`strict`, `balanced`, and `relaxed` profiles define how aggressively BBC should enforce context-first behavior
165+
166+
| Profile | Behavior |
167+
|---|---|
168+
| **strict** | Verified symbols only, impact-first workflow, verify-after-change, patch check, stale context blocks work |
169+
| **balanced** | Verified symbols only, verify-after-change, stale context warns but keeps workflow practical |
170+
| **relaxed** | Context-first guidance remains active, but broader iteration is allowed with warnings |
165171

166172
If a symbol is not in the sealed context, BBC returns: `"Information not found in sealed context"`
167173

@@ -259,7 +265,7 @@ Verification also runs automatically at the end of every `bbc start` and `bootst
259265

260266
---
261267

262-
## ️ CLI Commands
268+
## 🖥️ CLI Commands
263269

264270
All user-facing commands go through `bbc.py` — the single entry point:
265271

@@ -295,7 +301,7 @@ All user-facing commands go through `bbc.py` — the single entry point:
295301
296302
---
297303

298-
## 📂 Project Structure
304+
## 📂 Project Structure
299305

300306
```
301307
BBC/
@@ -370,7 +376,7 @@ MIT License — see [LICENSE](LICENSE) for details.
370376

371377
<div align="center">
372378

373-
**BBC v8.4 STABLE** — Your AI assistants now see your project through a verified sealed context.
379+
**BBC v8.5 STABLE** — Your AI assistants now see your project through a verified sealed context.
374380

375381
*No hallucinations. No guesswork. Only verified context.*
376382

0 commit comments

Comments
 (0)