Skip to content

AGENTS.md

Latest commit

 

History

History
43 lines (28 loc) · 2.07 KB

AGENTS.md

File metadata and controls

43 lines (28 loc) · 2.07 KB

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

A node-graph editor that compiles directly to binary machine code. The node graph is the canonical source — there is no text serialization. The UI is a configuration surface; the file format stores fully resolved, monomorphized types.

The binary is named node-compiler (Cargo package name). Currently early-stage: src/main.rs has the NodeKind and Value enums sketched out, with egui-snarl wired in as the node graph UI framework.

This is very much a work in progress, so make no effort whatsoever to maintain backwards compatiblity.

Commands

cargo build                                    # build
RUST_LOG='node_compiler=trace,warn' cargo run  # run
cargo check                                    # type-check without linking
cargo test                                     # run all tests
cargo test <name>                              # run a single test by name
cargo fmt                                      # format
cargo clippy                                   # lint
nix develop                                    # enter dev shell (NixOS environment)
rusty-man <crate>                              # after running `cargo doc` use it to get documentation

This project uses jujutsu so for any git commands, use whatever the jj equivalent is.

Architecture

Key dependencies

  • egui — immediate-mode GUI framework
  • egui-snarl — node graph widget for egui; provides SnarlViewer trait to implement for custom node rendering. Look up its API by reading source files under ~/.cargo/registry/src/

Core types (src/main.rs)

  • Value — runtime value enum (Bytes, Int, Float, Bool, Text, List, Map, Null)
  • NodeKind — node type enum covering primitives (Literal, FileSink, FileSource), byte manipulation (Concat, Slice, EncodeU32, DecodeU32), control flow (Map, Fold, Branch), introspection (GraphToList, ListToGraph), and composition (Subgraph)

Ignore

  • codebook.toml: This is just for a spellchecker.