Files
create/docs/src/reference/configuration.md
forbes-0023 f8a6c130af
Some checks failed
Build and Test / build (pull_request) Has been cancelled
docs: update Silo_New references for schema-driven creation form
- COMPONENTS.md: describe schema-driven form with runtime API fetching
- silo.md: update command description with domain/subcategory picker,
  dynamic properties, live PN preview; add schema_form.py and
  silo_start.py to directory structure
- configuration.md: update keyboard shortcut description
2026-02-11 10:34:28 -06:00

4.1 KiB

Configuration

Silo workbench

FreeCAD parameters

Stored in User parameter:BaseApp/Preferences/Mod/KindredSilo:

Parameter Type Default Description
ApiUrl String (empty) Silo server API endpoint URL
SslVerify Bool true Verify SSL certificates when connecting to server
CaCertPath String (empty) Path to custom CA certificate for self-signed certs
ApiToken String (empty) Stored authentication token (set by Silo_Auth)
FirstStartChecked Bool false Whether the first-start settings prompt has been shown
ProjectsDir String ~/projects Local directory for checked-out CAD files

Environment variables

These override the FreeCAD parameter values when set:

Variable Default Description
SILO_API_URL http://localhost:8080/api Silo server API endpoint
SILO_PROJECTS_DIR ~/projects Local directory for checked-out files

Keyboard shortcuts

Recommended shortcuts (prompted on first workbench activation):

Shortcut Command
Ctrl+O Silo_Open — Search and open items
Ctrl+N Silo_New — Schema-driven item creation form
Ctrl+S Silo_Save — Save locally and upload
Ctrl+Shift+S Silo_Commit — Save with revision comment

Update checker

Stored in User parameter:BaseApp/Preferences/Mod/KindredCreate/Update:

Parameter Type Default Description
CheckEnabled Bool true Enable or disable update checks
CheckIntervalDays Int 1 Minimum days between checks
LastCheckTimestamp String (empty) ISO 8601 timestamp of last successful check
SkippedVersion String (empty) Version the user chose to skip

The checker queries:

https://git.kindred-systems.com/api/v1/repos/kindred/create/releases?limit=10

It compares the current version (injected at build time via version.py.in) against the latest non-draft, non-prerelease tag. The latest rolling tag is ignored. Checks run 10 seconds after GUI startup.

To disable: set CheckEnabled to false in FreeCAD preferences, or set CheckIntervalDays to 0 for on-demand only.

Theme

The default theme is Catppuccin Mocha applied via KindredCreate.qss.

Setting Location
Canonical stylesheet src/Gui/Stylesheets/KindredCreate.qss
Preference pack src/Gui/PreferencePacks/KindredCreate/
Default theme name coal (in mdBook docs) / KindredCreate (in app)

To switch themes: Edit > Preferences > General > Stylesheet and select a different .qss file.

The preference pack is synced from the canonical stylesheet at build time via CMake's configure_file(). Edits should be made to the canonical file, not the preference pack copy.

Build configuration

Version constants

Defined in the root CMakeLists.txt:

Constant Value Description
KINDRED_CREATE_VERSION 0.1.0 Kindred Create version
FREECAD_VERSION 1.0.0 FreeCAD base version

These are injected into src/Mod/Create/version.py at build time via version.py.in.

CMake presets

Defined in CMakePresets.json:

Preset Platform Build type
conda-linux-debug Linux Debug
conda-linux-release Linux Release
conda-macos-debug macOS Debug
conda-macos-release macOS Release
conda-windows-debug Windows Debug
conda-windows-release Windows Release

ccache

Setting Value
Max size 4 GB
Compression zlib level 6
Sloppiness include_file_ctime,include_file_mtime,pch_defines,time_macros

ccache is auto-detected by CMake at configure time. Clear with ccache -C.

Silo server

Server configuration is documented in the dedicated Silo Server Configuration reference, which covers all YAML config sections (database, storage, auth, server, schemas) with full option tables and examples.