Configuration
Project files and environment variables used by Miblo and your generated Rust API.
On this page
Important files
| File | Purpose |
|---|---|
miblo.yaml | Version 1 project, model, field and route definition. |
.miblo/state.json | Pinned packs, fingerprints and merge baselines. |
.miblo/backups/ | Source backups created during model changes. |
.env | Private runtime configuration. |
.env.example | Shareable example. |
migrations/ | Versioned SQL history. |
Cargo.lock | Dependency versions. |
Commit source, migrations, miblo.yaml and .miblo/state.json. Private .env files are hidden in the explorer; .env.example remains visible.
Environment variables
| Variable | Purpose |
|---|---|
DATABASE_URL | API connection; database-command fallback when absent from .env. |
SERVER_ADDRESS / SERVER_PORT | Server listener; refresh after changes. |
MIBLO_TEMPLATE_DIR | Local development pack. |
MIBLO_TEMPLATE_BASE_URL | Template distribution server. |
MIBLO_CACHE_DIR | Template cache. |
MIBLO_LANGUAGE | en or fr: language override at startup. |
MIBLO_CONFIG_DIR | User preferences directory. |
VISUAL / EDITOR | Editor and arguments. |
MIBLO_NO_ANIMATION | Disables startup animation when set. |
For the address monitored by the workspace, environment values take priority over .env and project defaults. Wildcard bind addresses are checked through loopback. Avoid conflicting values.
User preferences
The language choice is saved in settings.json, outside your API projects:
- macOS:
~/Library/Application Support/miblo/settings.json - Linux:
$XDG_CONFIG_HOME/miblo/settings.json, or~/.config/miblo/settings.json - Windows:
%APPDATA%\miblo\settings.json
XDG_CONFIG_HOME also takes precedence on macOS. MIBLO_CONFIG_DIR overrides this directory on all platforms.
At startup, MIBLO_LANGUAGE=en or MIBLO_LANGUAGE=fr overrides the saved preference. Without either, Miblo uses English. You can still switch from the menu during the session.
If saving fails, Miblo reports it and applies the choice for the current session. An invalid preferences file does not prevent startup and is not overwritten.
Create from a definition
A YAML file can describe a new project:
schema_version: 1
name: team-api
stack: rust-axum-sqlite
port: 3000
resources:
- name: User
path: /users
fields:
- name: name
type: stringmiblo new --config path/to/miblo.yaml --yesThe destination directory must not exist. Editing this file in an existing project does not migrate its database: use miblo edit to add fields.
Project versions
| Format | Version |
|---|---|
| miblo.yaml definition | schema_version: 1 |
| Current templates | Pack 0.6.0, format 3 |
| Template formats read by the CLI | 1, 2 and 3 |
A project can contain models from different packs. Legacy config.yaml files are not converted automatically. Engine changes, renames and removals require manual migrations.