Skip to content

Latest commit

 

History

History
49 lines (39 loc) · 2.11 KB

File metadata and controls

49 lines (39 loc) · 2.11 KB

llm-grace: AI-Assisted Development Setup

Current Implementation Boundary

This is a development checkout, not an installable production service. The sampler and crash-safe ledger work is tracked in GitHub issue #4. Do not install a global daemon, wire production hooks, or promise recovery of user work based on this scaffolding.

Obtain and Inspect the Source

git clone https://github.com/hyperpolymath/llm-grace.git
cd llm-grace
scripts/run.sh help
scripts/run.sh check

Read CLAUDE.md, docs/practice/AI-CONVENTIONS.adoc, README.adoc, AUDIT.adoc, READINESS.adoc, SECURITY.adoc, and the applicable ADRs before making changes. The shell entrypoint is scripts/run.sh; it delegates to scripts/dev.sh and never starts a monitor or installs hooks. If Just is installed, use just --list and the same repository recipes (just check, just test Debug, just test ReleaseSafe). GEMINI.md, .github/copilot-instructions.md, and .claude/settings.json are provider-specific entrypoints that point to the same repo conventions.

Zig 0.15.2, GNU timeout, and LMDB development headers/library are required for core tests. Set LMDB_PREFIX when LMDB is installed outside system paths. Missing tools are reported by scripts/dev.sh doctor; no package installation is performed automatically. Consult .tool-versions and component build notes before selecting compiler versions. Do not pipe remote installation scripts into a shell without reviewing and verifying their provenance.

Privacy and Isolation

Never send credentials, private prompts, ledger records, or full process environments to an assistant. Review commands before execution. Keep experimental memory pressure and process signalling inside a disposable, resource-limited session; no privileged or global deployment is authorized by this guide.

Licensing Boundary

Issue #2 reserves existing license/SPDX changes to manual owner review. Agents must not relicense files, expand blanket licensing globs, or rewrite third-party headers as part of setup. Report conflicts instead.