Squid

Squid is an LLM-readable systems language. Every effect is visible at the call site, every parameter and return type is explicit, and contracts live beside signatures. The compiler is optimized for partial-context understanding by humans and language models.

Why

LLMs fail when important behavior is hidden far from the code they are editing. Squid pushes effects, allocation, fallibility, imports, contracts, and diagnostics into stable visible surfaces, then uses the Claude <-> Codex rubber-duck workflow to critique each design and implementation pass before it lands.

Status

v0 - usable language. v0.1 - self-hosted compiler in development.

Install

git clone <repo-url> squid
cd squid
zig build
zig build test

Prerequisites: Zig 0.16+. Optional: LLVM plus llvm-config for the LLVM backend (zig build -Dllvm=true), and clang for linking C-emit output.

Hello World

zig-out/bin/squidc run examples/hello.sq

Examples

See examples/markdown/ for a multi-file Markdown-to-HTML converter that exercises imports, Vec, pattern matching, string processing, read_file, and write_file.

LLM-Friendliness

Methodology and current numbers live in docs/llm-friendliness.md.

Workflow

Project workflow and phase status live in RESUME.md.

License

License: TBD; planned MIT for v0.1.