Terminal interface and shortcuts

Navigate Miblo’s terminal workspace, manage your API and read its status indicators.

▶ Watch the demo
On this page

Main actions

KeyAction
n / oCreate / open an API
aAdd model, table and CRUD
mAdd fields or relationships to an existing model
gCreate a route
r / sStart / stop the API
bConfigure, initialize or migrate the database
d / pShow schema / switch its source
x / EnterTest the selected route
fCustom HTTP request
eOpen code in your editor
cRun cargo check
uUpdate templates for future additions
t / F5Change theme / refresh
Shift+LChoose English or French and save the preference
qQuit

Choose Miblo’s language

Since 0.9.1, Miblo starts in English, regardless of your system language.

  1. Press Shift+L (uppercase L), or open Space → Language / Langue.
  2. Choose English or Français with the arrows, then press Enter.

:language and :langue open the same menu. The change is immediate and saved for the next launch. Your project stays open and the API keeps running.

Menus, forms, help and status panels use the selected language. Generated files, SQL data and existing logs keep their content. Command names and --help remain in English; generated comments and README files follow the template pack’s language.

The website’s EN / FR switch only changes the documentation. Use the application menu to change Miblo. Preferences and language overrides →

Command bar

Press : to enter a workspace command:

workspace commands
:new    :open path/to/project    :add    :model
:run    :stop    :db    :migrate    :schema    :templates
:routes    :route-new    :route    :request    :code
:check    :test    :doctor    :edit    :refresh    :theme
:language    :langue    :help    :quit

Workspace commands are not all CLI subcommands. Use the CLI reference for scripts.

Read status indicators

ColorAPIDatabase
GreenHTTP health check responds.Connected; migrations up to date.
OrangeStarting or restart required.Initialization or pending migrations.
RedProcess or response error.Connection failed or inconsistent migration.
GrayStopped or no project.Check pending or no database.

Status refreshes about every three seconds. Miblo identifies an externally started API and does not stop that process.

Editor, animation and exit

e uses VISUAL, then EDITOR, then vi on Unix or notepad on Windows. Arguments such as EDITOR="code --wait" are supported. Miblo restores the terminal while you edit.

Any key skips the blue startup animation; set MIBLO_NO_ANIMATION=1 to disable it. Three session themes are available.

Normal exit stops the processes Miblo started. Finish generation, compilation and HTTP jobs first: exit is blocked while those jobs are running.

Search for a feature or command.

↑ ↓ browse Enter to open