bino init

bino init creates a new workdir with sample manifests, data, and configuration. It is the recommended way to start a new report bundle.

Usage

bino init [SOURCE] [flags]

SOURCE is optional. With no source it renders the built-in minimal scaffold; standard renders the full reference bundle - a CSV datasource, a dataset, an IBCS table, a chart, a component style, en/de translations and asset declarations, laid out in the canonical folders. predef scaffolds a predef project: an ordinary project that also authors a reusable package, with a [package] table in bino.toml, namespaced manifests and a mocks/ preview harness. A source may also be a remote template - see Project Templates for the full grammar, manifest format, and security model.

Common flags:

• --directory, -d (alias -o, --output) - target directory (default ./rainbow-report for built-ins; required for remote templates).
• --name - internal report name; for predef the package name segment (built-in templates).
• --title - human-readable report title (built-in templates).
• --language - language code, for example en, de (built-in templates).
• --set key=value - set a template field value; repeatable. Remote/local templates declare their own fields; predef accepts the [package] fields Scope, Description, Visibility, Tags (comma-separated) and Category.
• -y, --yes - run non-interactively with defaults.
• --force - overwrite existing files.
• --offline - never reach the network; require a cached template (also BINO_OFFLINE).
• --trust - skip the confirmation prompt for an uncurated remote source.
• --json - emit the result (directory, files, template, resolved SHA, folders) as JSON.

Examples

Create a bundle in the current directory interactively:

bino init

Scaffold the full standard reference bundle:

bino init standard -d monthly-report

Scaffold a predef project that authors a reusable package:

bino init predef -d starter-kit

The predef wizard asks for the [package] table instead of the report fields: registry scope, package name, description, visibility, tags and category. To skip the wizard, pass them with --set:

bino init predef -d starter-kit --set Scope=myorg --set Visibility=public -y

Create a bundle non-interactively with explicit title and language:

bino init --directory monthly-report --title "Monthly Sales" --language en -y

Scaffold from a remote template, pinned to a tag, supplying fields:

bino init owner/report-template#v1.2.0 -o ./out --set ReportName=q3 --trust

After initialization, continue with Your first report.

The bino.toml Configuration File

Every Bino project contains a bino.toml file in its root directory. This file stores the project’s unique identifier and can define default arguments and environment variables for CLI commands.

Structure

report-id = "550e8400-e29b-41d4-a716-446655440000"

[build.args]
out-dir = "dist"
browser = "chromium"
log-sql = false
no-lint = false

[build.env]
BNR_MAX_QUERY_ROWS = "50000"
DATABASE_URL = "postgres://localhost/mydb"

[preview.args]
port = 8080
lint = true

[preview.env]
BNR_MAX_QUERY_ROWS = "10000"

Setting Command Defaults

You can define default values for any flag supported by bino build or bino preview. When you run a command, the CLI:

1. Reads the defaults from bino.toml
2. Applies any explicit command-line flags (which override the TOML values)
3. Logs an info message when a TOML value is overridden

Build Defaults

Configure defaults for bino build in the [build.args] section:

[build.args]
out-dir = "output"           # Output directory for generated PDFs
browser = "firefox"          # Browser engine: chromium, firefox, webkit
log-sql = true               # Log SQL queries during build
no-graph = true              # Skip dependency graph files
no-lint = false              # Run lint rules (default)
build-log-format = "json"    # Build log file format: text or json
embed-data-csv = true        # Embed CSV data in logs
embed-data-max-rows = 20     # Max rows per embedded CSV
embed-data-max-bytes = 131072
embed-data-base64 = true
embed-data-redact = true
detailed-execution-plan = true
artefact = ["monthly", "weekly"]       # Build only these artefacts
exclude-artefact = ["draft"]           # Skip these artefacts

Preview Defaults

Configure defaults for bino preview in the [preview.args] section:

[preview.args]
port = 9000                  # Preview server port
log-sql = true               # Log SQL queries
lint = true                  # Run lint rules on refresh

Setting Environment Variables

You can define environment variables for each command using [build.env] and [preview.env] sections. This is useful for setting runtime configuration like query limits or database connection strings.

Build Environment

[build.env]
BNR_MAX_QUERY_ROWS = "100000"      # Maximum rows per query
BNR_MAX_QUERY_DURATION_MS = "120000"  # Query timeout (2 minutes)
DATABASE_URL = "postgres://prod-server/reports"
API_KEY = "default-key-for-builds"

Preview Environment

[preview.env]
BNR_MAX_QUERY_ROWS = "10000"       # Lower limit for faster previews
BNR_CDN_MAX_BYTES = "10485760"     # 10 MB CDN cache limit
DATABASE_URL = "postgres://localhost/dev"

Override Priority

The configuration follows a clear priority order (highest to lowest):

1. Actual environment variables - System or shell environment variables always take precedence
2. TOML environment values - Values from [build.env] or [preview.env]
3. Default values - Built-in defaults

For command-line flags:

1. Explicit CLI flags - Flags passed on the command line
2. TOML args values - Values from [build.args] or [preview.args]
3. Default values - Built-in defaults

Override Messages

The CLI informs you when values are overridden:

When a CLI flag overrides a TOML arg:

$ bino build --browser webkit
Overriding browser from bino.toml ("firefox" -> "webkit")

When an environment variable overrides a TOML env value:

$ BNR_MAX_QUERY_ROWS=200000 bino build
Environment variable BNR_MAX_QUERY_ROWS overrides bino.toml ("100000" -> "200000")

This makes it easy to use project-wide defaults while still allowing one-off overrides for specific runs or CI environments.