jinflow Quick Start

This guide gets you from zero to exploring in 5 minutes. For detailed documentation, see the User Guides.

What is jinflow?

jinflow is a declarative analytical engine. You declare signals, theses, and verdicts; jinflow compiles them to SQL, builds a DuckDB knowledge store (KLS), and serves it through the Explorer web app.

Domain knowledge lives in packs (e.g. a healthcare pack, a winemaking pack, a logistics pack). The engine handles compilation, validation, and exploration.

Install

Download the latest release for your platform from jinflow.io. The package is self-contained — no Python, Node, or dbt installation required.

# Extract the release package and add to PATH
export PATH="$HOME/jinflow:$PATH"
jinflow version                       # verify installation

5-Minute Walkthrough

1. Configure

jinflow us --live-root ~/jinflow-live       # where tenant data lives
jinflow us --tenant millesime.domaine_zufferey  # set your default tenant
jinflow us                                  # verify config

See Setup Guide for full resolution order and DLZ configuration.

2. Initialize a tenant

jinflow init --pack millesime --tenant domaine_zufferey --source-system opale

This creates ~/jinflow-live/millesime/domaine_zufferey/ with afs/, raw/, build/, store/ directories.

See Tenants Guide for pack-qualified IDs, cloning, and multi-pack.

3. Build

jinflow make --tenant millesime.domaine_zufferey

This runs the full pipeline: validate CSVs, compile instruments, run dbt (Bronze -> Silver -> Gold -> Signals -> Theses -> Verdicts), generate reports, and stamp the KLS.

See Make Guide for flags (--sync, --extract, --clean, --snapshot).

4. Explore

jinflow explore --tenant millesime.domaine_zufferey

Opens the Explorer at localhost:4000. Browse theses, findings, dimensions, taxonomies, SMEbits, and reports.

See Explorer Guide for pages, keyboard shortcuts, JumpBar, and saved views.

5. Iterate

# Edit YAML instruments in the AFS (signals/, theses/, smebits/, etc.)
jinflow make                    # rebuild
jinflow explore                 # see the impact
jinflow make --snapshot         # freeze when happy

See Instruments Guide for all instrument types.

The Core Loop

Key Concepts

Term	Meaning
Pack	Domain-specific analytics kit (e.g. Millesime, Alptrack)
Tenant	One client/site. Pack-qualified: millesime.domaine_zufferey
KLS	Knowledge Store — the DuckDB file you build and explore
AFS	Artifact Store — the analytical framework (git-backed)
SIS	System Information Store — mutable user state (notebooks, saved views)
DLZ	Data Landing Zone — where raw data arrives
Snapshot	Immutable, frozen copy of a KLS

Further Reading

• Setup — roots, config, resolution order
• Make — build pipeline, flags, phases
• Explorer — pages, JumpBar, search syntax
• Tenants — multi-tenant, cloning, AFS sync
• Instruments — signals, theses, verdicts, SMEbits, reports
• Collaboration — git workflow, AFS push/pull
• Deploy — desktop, Docker, cloud
• AI — evolve REPL, finding explainer
• Notes — notebooks, SIS merge
• Cheatsheet — all commands at a glance