-
Notifications
You must be signed in to change notification settings - Fork 0
Runtime Model
Use this page for
understanding daemon mode, snapshots, hook-sidecar behavior, and environment variables.
At startup, SymForge:
- discovers a project root unless auto-indexing is disabled
- attempts to connect to or start a local daemon
- falls back to local in-process mode if needed
- starts with an empty index if no project root is found
Run:
symforge daemonDaemon mode is useful when multiple sessions should share one index.
Index snapshots persist at:
.symforge/index.bin
This improves restart speed and reduces unnecessary reindexing work.
Hook and sidecar behavior matters most for clients such as Claude Code that integrate SymForge into read/edit interception flows.
Relevant project-local files may include:
.symforge/sidecar.port.symforge/sidecar.pid.symforge/sidecar.session.symforge/hook-adoption.log
When hook infrastructure is unavailable, the intended behavior is fail-open with diagnostics rather than a hard block.
Some MCP clients stringify parameters. SymForge accepts common stringified forms for:
- booleans
- numbers
- arrays
- arrays of stringified objects
This is mainly to reduce friction across heterogeneous MCP clients and extensions.
| Variable | Default | Effect |
|---|---|---|
SYMFORGE_HOME |
~/.symforge |
Home directory for binary and daemon metadata |
SYMFORGE_AUTO_INDEX |
true |
Enables project discovery and startup indexing |
SYMFORGE_HOOK_VERBOSE |
unset | Set to 1 for hook stderr diagnostics |
SYMFORGE_CB_THRESHOLD |
0.20 |
Parse-failure circuit-breaker threshold |
SYMFORGE_SIDECAR_BIND |
127.0.0.1 |
Sidecar bind host for local in-process mode |
- Use
healthto inspect daemon and index state. - Use
index_folderto refresh stale or missing project state. - Use
analyze_file_impactafter targeted edits. - Treat daemon mode as optional optimization, not a requirement for normal use.
Tip
If SymForge appears unavailable in a client, the first recovery sequence is usually
healthfollowed byindex_folder, not immediate fallback to raw file tools.