jinflow Setup Guide

1. Configure your roots

Edit ~/.jinflow/config.yml:

live_root: ~/jinflow-live         # where tenant instances live

• live_root — where jinflow init creates tenant instances and jinflow make writes KLS files.

Supports ~ expansion and can also be set via JINFLOW_LIVE environment variable.

Optional: pack root and DLZ root

If you use domain packs or receive source data via a Data Landing Zone:

pack_root: ~/jinflow-packs                  # where domain pack repos are cloned
dlz_root: ~/jinflow-datalandingzone         # where source data arrives

• pack_root — where jinflow looks for packs by name. Only needed if you use --pack on init.
• dlz_root — convention: {dlz_root}/{pack}/{tenant}/{source_system}/csv/.

Both can also be set via environment variables (JINFLOW_PACKS_ROOT, JINFLOW_DLZ_ROOT).

2. Initialize a tenant

Starting from scratch

jinflow init --tenant my_analysis --source-system opale

This creates an empty tenant with a blank AFS — you write your own signals, theses, and dbt models.

Starting from a domain pack

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

This copies the pack’s analytical framework into the tenant. The pack is a starter kit — after init, the tenant is independent.

What init creates

{live_root}/{pack_or_default}/domaine_new/
  afs/      ← analytical framework (your instruments, dbt models, contracts)
  raw/      ← place your source CSVs here
  build/    ← intermediaries (compiled SQL, enriched CSVs)
  store/    ← KLS + SIS (built by make)

With DLZ

jinflow init --pack millesime --tenant domaine_new --source-system opale \
  --dlzroot ~/jinflow-datalandingzone

This also links the tenant to its DLZ path for --sync.

3. Use pack-qualified tenant IDs

All commands use pack.tenant notation:

jinflow make --tenant millesime.domaine_new
jinflow explore --tenant millesime.domaine_new
jinflow afs update --tenant millesime.domaine_new
jinflow us --tenant millesime.domaine_new     # set as default

Set a default tenant

jinflow us --tenant millesime.domaine_new

After this, commands without --tenant will use the default.

4. Check your config

jinflow us

Shows live_root, pack_root, default tenant, and where each setting was resolved from (env var, config.yml, or default).

5. Day-to-day workflow

# Build the KLS
jinflow make

# Explore in browser
jinflow explore

# Edit instruments (signals, theses, etc.) in afs/, rebuild
jinflow make

# Freeze a snapshot when happy
jinflow make --snapshot

# If using a DLZ: copy fresh CSVs before building
jinflow make --sync

# If using a domain pack: pull latest pack changes
jinflow afs update --do-it

Resolution order

Setting	1st	2nd	3rd	Default
live_root	JINFLOW_LIVE env	~/.jinflow/config.yml	—	~/.jinflow/live/
pack_root	JINFLOW_PACKS_ROOT env	~/.jinflow/config.yml	engine packs/ dir	—
dlz_root	JINFLOW_DLZ_ROOT env	~/.jinflow/config.yml	AFS jinflow.yml	—
tenant	JINFLOW_TENANT env	~/.jinflow/config.yml	AFS default_tenants	—