- Deliver a local-first embedding management AC2E platform that accelerates retrieval-augmented workflows without relying on external services.
- Provide deterministic ingestion across mixed repositories while preserving governance, auditability, and the 4C documentation standard.
- Empower developers with tooling that integrates seamlessly into existing CLI, IDE, and automation pipelines.
flowchart LR
subgraph Workspace[Local Workspace]
Sources[Repositories & Documents]
Policies[Ignore & Sanitization Rules]
end
subgraph Runtime[Local Runtime]
Transport[Transport Adapters]
Pipeline[Ingestion & Validation Pipeline]
Vault[Encrypted Persistence]
end
subgraph Clients
CLI[CLI & Client Scripts]
IDE[IDE Extensions]
API[Local HTTP Consumers]
end
Sources --> Pipeline
Policies --> Pipeline
Clients --> Transport --> Pipeline --> Vault
Vault --> Transport
- Local transports (HTTP, stdio, and Unix domain sockets) keep traffic on-device while supporting diverse client scenarios.
- The ingestion pipeline enforces ignore policies, sanitizes inputs, and streams embeddings into encrypted storage.
- Encrypted persistence and manifest auditing provide reproducible state across multi-repository environments.
- Encrypted stores are backed by per-repository keys and audited manifest chains to prevent tampering and rollback attacks.
- Transport adapters enforce authentication, input validation, and zero-trust defaults for CLI, IDE, and automation clients.
- Threat modeling, mitigation tracking, and checklist completion are mandated for every change; reference
docs/security/threat-model.md
.
- Plan before code: Draft and circulate an implementation plan before touching source files, per
AGENTS.md
. - Test-driven development (TDD): Capture expected behavior in failing tests ahead of implementation and keep regression suites green.
- Documentation discipline: Maintain 4C compliance—ensure updates are clear, concise, complete, and correct, and synchronize README and related docs with feature changes.
- Release readiness: Run
rustfmt
,cargo clippy --all-targets --all-features
, and complete the PR release checklist before requesting review.
- Design Overview: Architectural context, ingestion pipeline details, and transport adapters in
docs/design/overview.md
. - Testing Strategy: Platform and scenario coverage in
docs/testing/test-matrix.md
. - Security Guidance: Threat modeling reference and controls in
docs/security/threat-model.md
. - Process & Governance: Contribution governance, decision logs, and release workflow in
docs/process/
. - Fixture Tooling: Multi-language script stubs, runtime requirements, and linting expectations in
scripts/README.md
.
The scripts/
directory now hosts descriptive stubs for the tooling
referenced throughout docs/testing/fixtures-plan.md
and docs/testing/ci-coverage.md
. Each placeholder
captures its intended responsibilities plus the runtimes and third-party
dependencies required to regenerate fixtures across Windows, macOS, Linux, and
WSL environments.
When implementing these utilities:
- Follow the linting and formatting expectations documented in
scripts/README.md
(ruff
/black
for Python,rustfmt
/clippy
for Rust,shfmt
/shellcheck
for shell, andPSScriptAnalyzer
for PowerShell). - Document new configuration switches or host prerequisites directly in the script docstrings and associated fixture READMEs to keep regeneration guidance complete.
- Update CI workflows to invoke the appropriate linters once the scripts move beyond placeholder status.
Two GitHub Actions workflows codify the regeneration sequences documented in the fixture management plan:
- Regenerate Fixture Corpus (
.github/workflows/regenerate-fixtures.yml
) sets up Python 3.11, installs the documented dependencies (watchdog
,pyyaml
,typer
,rich
,click
,cryptography
,networkx
), and primes the stable Rust toolchain before invoking each fixture-generation script. The workflow uploads the refreshedtests/fixtures/
tree and fixture-adjacent goldens as a short-lived artifact (fixture-regeneration-output
) so reviewers can download and inspect the regenerated assets. - Regenerate Golden Artifacts (
.github/workflows/regenerate-goldens.yml
) mirrors the environment bootstrap and focuses on transcripts and logs undertests/golden/
, publishing thegolden-regeneration-output
artifact with the captured results.
Both workflows expose a manual workflow_dispatch
trigger with two optional
inputs:
dry_run=true
validates that the required toolchains install cleanly without executing the capture scripts.skip_artifact_upload=true
is available when local testing already captured the artifacts and the Actions run should avoid storing duplicates.
The Linux jobs continue to build the cross-platform fixtures, while dedicated Windows jobs now execute the PowerShell helpers:
scripts/collect_dpapi.ps1
emits deterministic DPAPI recovery fixtures and the matching audit log, placing outputs directly undertests/fixtures/security/dpapi-recovery/
andtests/golden/security/dpapi-recovery-audit.jsonl
.scripts/trace_capture.sh
generates TLS handshakes, downgrade fuzz logs, negotiation transcripts, and latency profiles without human input.scripts/wsl_transport_proxy.ps1
records the Windows-to-WSL bridge metadata and negotiation trace consumed by transport regression tests.
The Windows jobs upload their results as the windows-security-fixtures
and
windows-security-goldens
artifacts. The corresponding Linux jobs declare a
dependency on these captures, download them into the workspace, and then run the
remaining regeneration steps (checksum validation, archive synthesis, etc.). The
checksum verification step (scripts/checksums.sh --verify
) now runs by default
so regressions are surfaced immediately during fixture or golden refreshes.
- Client integration patterns and validated scripts will land in
docs/integration/clients.md
; watch for connector templates and signing guidance. - IDE and editor onboarding lives in
docs/integration/ide-overview.md
, which will link to language-specific SDKs and Marketplace packages as they are published. - A starter toolkit (CLI wrappers, VS Code tasks, and JetBrains run configurations) will ship alongside the integration docs so new contributors can bootstrap local testing quickly.
- Review the design, security, testing, and process documentation.
- Draft your implementation plan and secure consensus before writing code.
- Implement features with TDD, run the required linters, and document changes following the 4C standard.