soldermaskdocs

Configuration

Everything is an environment variable or a serve flag; there is no config file.

Where things live

VariableDefaultMeaning
SOLDERMASK_HOMEthe repository in a checkout, otherwise the platform's data directory (~/Library/Application Support/soldermask, $XDG_DATA_HOME/soldermask)base directory for data: projects/ and .cache/ are under it
SOLDERMASK_PROJECTS$SOLDERMASK_HOME/projectsthe projects directory
SOLDERMASK_CACHE$SOLDERMASK_HOME/.cacheparts, footprints, symbols, 3D models, the LAN certificate, the access token
SOLDERMASK_DOCS<repo>/sitethe built manual the app serves at /docs

The model

VariableMeaning
SOLDERMASK_BACKENDgemini (default) or claude; SILIXON_BACKEND is still honoured
SOLDERMASK_AUTO_REPAIR1 (default): a chat turn whose build comes back with unresolved parts or electrical errors is sent back to the model once and the revision built if it scores better; 0 turns it off, N allows N rounds
GEMINI_API_KEY / GOOGLE_API_KEYGemini credentials
ANTHROPIC_API_KEYClaude credentials (a logged-in ant auth profile also works)

Serving

Variable / flagMeaning
SOLDERMASK_TOKENthe access token; off / none / 0 disables auth (same as --no-auth)
--token, --no-auth, --proxy, --workers, --log-file, --http, --port, --hostsee Command line

The cache

.cache/ is safe to delete; everything in it is refetched or regenerated. It holds: parts/ (24-hour TTL), easyeda/ (footprints and symbols by LCSC code, kept until refreshed), models3d/ (3D models, versioned by CACHE_VERSION), kicad-symbols/ and symbol_index.json (the KiCad library and its 42 MB index), lan-cert.pem/lan-key.pem (the self-signed certificate) and access-token.

Tooling

VariableMeaning
SNAP_CHROMEthe Chromium binary for tools/snap.py; the Playwright cache is searched otherwise
PW_CORE, PW_CHROMIUMplaywright-core and its browser for tests/verify_3d.js

Routability

VariableDefaultWhat it moves
SOLDERMASK_CORPUS.cache/corpuswhere every route the pipeline runs is kept, and where soldermask learn generate writes
SOLDERMASK_FREEROUTING_JARvendor/freerouting-2.4.1.jar in a checkout, .cache/vendor/freerouting-2.4.1.jar installedthe router. The name recorded against every label follows this file, so pointing it elsewhere relabels honestly
SOLDERMASK_ROUTABILITYsoldermask/assets/routability.jsonthe model file the placer ranks candidates with; point it at a soldermask learn train --out file to try one without shipping it

Described in Routability.

On this page