Constants§
- ANALYTICS_
DB_ NAME - API_
KEYS_ DB_ NAME - COUPLING_
DB_ NAME - FRECENCY_
DB_ NAME - Bare db filenames (no
.symforge/prefix). These are thenameargument tosymforge_db_path— the ONLY sanctioned way to build a.symforge/<name>.dbon-disk path. Keeping them bare is the whole point: the prefix lives in exactly one place (the helper), so no store can hand-roll a path and double the prefix (D1-ROOT — the defect that shipped a doubledroot/.symforge/.symforge/...path). - IDEMPOTENCY_
DIR_ NAME - INDEX_
SNAPSHOT_ QUARANTINE_ RELATIVE_ PATH - STEL_
LEDGER_ DB_ NAME - SYMFORGE_
ARTIFACT_ QUARANTINE_ DIR_ PATH - contracts/team-artifact.md § Integrity failure.
- SYMFORGE_
DIR_ NAME - SYMFORGE_
IDEMPOTENCY_ DIR_ PATH - SYMFORGE_
IDEMPOTENCY_ QUARANTINE_ DIR_ PATH - SYMFORGE_
IDEMPOTENCY_ RECORDS_ DIR_ PATH - SYMFORGE_
INDEX_ SNAPSHOT_ QUARANTINE_ DIR_ PATH
Functions§
- control_
state_ path - Build a path owned by the process-global control-state directory.
- ensure_
artifact_ quarantine_ dir - Ensure the canonical team-artifact quarantine directory exists under
base. - ensure_
control_ state_ dir - Ensure the resolved process-global control-state owner exists.
- ensure_
idempotency_ dir - Ensure the canonical idempotency replay directory exists under
base. - ensure_
index_ snapshot_ quarantine_ dir - Ensure the canonical index-snapshot quarantine directory exists under
base. - ensure_
project_ state_ db_ path - Ensure the resolved project-state owner, then return one bare database path.
- ensure_
project_ state_ dir - Ensure the resolved project-state owner exists.
- ensure_
runtime_ symforge_ dir - Ensure runtime
.symforgestate exists, falling back toglobal_symforge_homewhen the preferred project/cwd base is unsafe or not writable. - ensure_
symforge_ db_ path - Ensure
root/.symforgeexists, then return the db pathroot/.symforge/<name>. - ensure_
symforge_ dir - Ensure the canonical symforge data directory exists under
base. - global_
symforge_ home - User-level SymForge home for runtime files when no safe project root exists.
- is_
sensitive_ path - Returns true if
canonicalis a sensitive system or credential-bearing directory (or a descendant of one) that must never be indexed. - os_
runtime_ tag - OS isolation tag for per-process runtime files (sidecar/daemon port/pid/session).
- os_
tagged_ runtime_ file_ name - Build an OS-tagged runtime filename:
sidecar_runtime_file_name("sidecar", "port")yields e.g."sidecar.linux.port". The extension is preserved so docs/tools that key on.port/.pid/.sessioncontinue to match, and the file stays a sibling in the same.symforge/directory. - process_
control_ state_ placement - Resolve the process-global control owner exactly once and share that same placement with every control-state reader and writer.
- project_
state_ path - Build a path owned by an already-resolved project-state directory.
- resolve_
artifact_ quarantine_ dir - Resolve the canonical team-artifact quarantine directory under
base(contracts/team-artifact.md § Integrity failure). - resolve_
control_ state_ placement - Resolve the process-global control-state lane without consulting a source root or launch CWD.
- resolve_
idempotency_ dir - Resolve the canonical idempotency replay directory under
base. - resolve_
index_ snapshot_ quarantine_ dir - Resolve the canonical index-snapshot quarantine directory under
base. - resolve_
symforge_ dir - Resolve the canonical symforge data directory under
base. - resolve_
user_ local_ project_ state_ base - Resolve the user-local base for a newly constructed project instance.
- select_
runtime_ data_ base - Choose the base directory for runtime
.symforgestate (sidecar port/pid files, init bootstrap, etc.) without creating it. - symforge_
db_ path - Build the canonical on-disk path for a symforge db:
root/.symforge/<name>.