graph_icsGuide chapters
Reference
Look up exact CLI options, Python interfaces and algorithm details. For visual explanations, use the topic chapters in the sidebar.
Reference documents
- Python API
- Parameters and units
- Growth algorithm
- Scene schema
- Replay format and export
- Installation
- CLI recipes
All command-line options
| Option | What it does | Example |
|---|---|---|
--fill-area | Search unfilled space with periodic reseeding; nodes remains a safety cap. Stops report exhausted search or limits, not complete packing. | Visual example |
--config | Load a complete JSON/YAML scene; file paths resolve beside that scene. | Visual example |
--gif | Export an opaque looping GIF instead of individual PNG frames. | Visual example |
--node-inner-radius / --node-outer-radius / --node-buffer | Inner and outer ring radii, and clearance to unrelated geometry, in world units. | Visual example |
--edge-thickness / --edge-node-distance / --edge-length-min / --edge-length-max | Full stroke width, ring-to-line gap, and visible length range in world units. | Visual example |
--example | Select a documented recipe; list shows names and describe explains it. | Visual example |
--palette | Choose colours for the complete scene; geometry stays the same unless text width changes. | Visual example |
--seed | Change the random layout; reuse the seed to reproduce it. | Visual example |
--nodes | Requested total population including seeds. Constraints can stop growth below it. | Visual example |
--node-shape | Circle, square, diamond, triangle or hexagon; hollow unless inner radius is zero. | Visual example |
--edge-style | Solid, dashed, dotted or double lines inside a collision-protected corridor. | Visual example |
--minimum-angle | Hard ban below this incident angle in degrees; straight continuation is 180. | Visual example |
--preferred-angle | Soft angular target; must be at least the hard minimum when nonzero. | Visual example |
--angle-penalty | Strength from 0 to 1 of soft rejection below the preferred angle. | Visual example |
--scale | Output units per world unit: larger image, same geometry. Compare native dimensions below. | Visual example |
--margin | World-unit whitespace around the region, scaled with the image. | Visual example |
--transparent | Leave the background transparent. Checkerboard indicates alpha in these previews. | Visual example |
--output | PNG/SVG file for render; new folder for frames; gallery folder for gallery. | Visual example |
--record | Save accepted events as JSONL while rendering; later replay needs no growth rerun. | Visual example |
--log | Read recorded geometry for frames. Recipe, seed and node target do not rebuild it. | Visual example |
--fps | Frames per second. More samples make the same event timeline smoother. | Visual example |
--seconds-per-event | Increase to slow the recorded growth; each event is given this duration. | Visual example |
--max-frames | Safety cap: an oversized frame sequence is rejected, not silently truncated. | Visual example |
--force | Allow render to replace its existing image or recording; does not affect appearance. | Visual example |
--all-palettes | Expand every regular recipe across all ten palettes instead of the curated selection. | Visual example |
--quick | Generate six small scenes plus this controls guide; omit for all recipes and large examples. | Visual example |
--help / -h | Show command-specific usage and defaults; no image is generated. | Visual example |