Skip to main content

Module paths

Module paths 

Source

Constants§

ANALYTICS_DB_NAME
API_KEYS_DB_NAME
COUPLING_DB_NAME
FRECENCY_DB_NAME
Bare db filenames (no .symforge/ prefix). These are the name argument to symforge_db_path — the ONLY sanctioned way to build a .symforge/<name>.db on-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 doubled root/.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 .symforge state exists, falling back to global_symforge_home when the preferred project/cwd base is unsafe or not writable.
ensure_symforge_db_path
Ensure root/.symforge exists, then return the db path root/.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 canonical is 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/.session continue 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 .symforge state (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>.