Skip to content

Home

Jump to bottom
Suddoku edited this page Apr 22, 2026 · 6 revisions

CellForge Wiki

Welcome to the CellForge documentation.

wiki

Getting started

  • Getting Started — download, install, first notebook in 5 minutes
  • README — install, architecture, highlights

Built-in features

  • Built-in Library — import cellforge as cf — charts, diagrams, widgets, progress bars, callouts, stat tiles. Full API reference.

Extensibility

  • Writing Themes — create color themes (CSS variable overrides). Simplest plugin type — just a JSON file.
  • Writing Plugins — full plugin development: Python helpers, custom renderers, toolbar buttons, sidebar panels, keybindings, export formats, status bar items.
  • Writing Typst Templates — custom PDF export templates with variables and assets.

For operators

  • Deployment-Security — threat model, security layers, per-scenario recommendations. Start here if you're about to expose CellForge to more than yourself.
  • Docker-Reference — image variants, Docker flags, compose.yml examples, why --privileged sometimes shows up.
  • Configuration-Reference — every CLI flag and env var in one place.

For developers

The repo's README.md covers local dev (scripts/dev.sh), the crate layout, and the frontend stack. The CellForge GitHub repo is the canonical source — this wiki is operator-facing.

Clone this wiki locally