Framework capabilities
The standalone framework is documented in its canonical README, which ships with each release. This page is an index: it points to the relevant sections and installed CLI guides instead of duplicating their API reference.
| If you want to… | Start here |
|---|---|
| Install the Python package, create a project, or build a report | Install and Quick Start · python -m trellum guide report |
| Query a source, inspect tables, or reuse a defined metric and track its version | Data Layer · python -m trellum guide answer queries metrics |
| Choose charts, tables, KPI cards, controls, or layout components | Components · python -m trellum guide components |
| Use cascading filters, cross-data-source propagation, section-local scopes, or chunked datasets | DataSource and FilterBar · Chunked DataSource Loading · python -m trellum guide filters |
| Run parameterized live queries or use long-format data, ratios, and stacked chart breakdowns | Live Queries · DataSource and FilterBar · python -m trellum guide live-queries format |
| Compare experiments or render confidence intervals and variance reduction | A/B Testing · python -m trellum guide components generator |
| Add themes, events, annotations, or browser exports (PNG, PDF, CSV) | Themes · Events and Annotations · JavaScript Runtime API |
| Validate a report and understand its check results | Validation · python -m trellum checks · python -m trellum guide validation |
| Build a multi-scope report, custom dashboard, or run a visual review loop | Multi-Scope Reports · Custom Dashboards · CLI Reference: review · python -m trellum guide review |
| Add custom components, themes, data drivers, or output backends | Extensibility |
The installed CLI describes the version in your environment. Run
python -m trellum for its command list, or request several guides together,
for example python -m trellum guide components filters validation.
The portal guide covers team workflows. Its pages document Git publishing, organizations and studios, access control, SSO, data-source connections, sharing, embedding, email delivery, alerts, live queries, experiments, annotations, and the AI assistant. The metrics catalog explains shared metric definitions and whether a report build uses the current definition; Report Analytics documents readership counts and their limits. The framework overview explains where the standalone package ends and portal operations begin.