Getting started

Documentation in progress

This site is being filled in. This page covers what runs today; the API, integration and export guides land next.

Run the server

MidLang ships as a Rust binary. From the repository root:

cargo run -p midlang-server -- --store mem --sqlite-url sqlite::memory:

The server binds 127.0.0.1:4321 by default. Useful flags:

Flag	Purpose
--port	Bind port, 4321 by default.
--store	redb (default, persistent) or mem (throwaway).
--store-url	Redb file path, translation.rdb by default.
--sqlite-url	Shared SQLite database for auth, issues, changelog and coverage.
--cors-origin	Allowed origins; repeat or comma-separate. Defaults to all origins for local development.
--coverage	Maintain per-locale coverage. On by default; pass --coverage false to skip the startup scan, which also disables the coverage API.

On the first start the server creates an admin token and prints it once. Store it before the process exits; it is not shown again.

The coverage endpoints answer 503 while --coverage is off, because there is no maintained state to read.

Open the admin console

cd web/midlang-webui
pnpm install
pnpm dev

The console asks for a server URL and that token. Set VITE_MIDLANG_REMOTE_URL (for example in web/midlang-webui/.env.local) to pre-fill the URL field.

Talk to the API directly

Reads and writes are bearer-token authenticated and permission-scoped:

curl -H "Authorization: Bearer $MIDLANG_TOKEN" \
  http://127.0.0.1:4321/t/zh-CN/greeting.hello

Keys can be namespaced, which yields a second route shape: /t/{locale}/{namespace}/{key}.

Coverage is read under the diagnostic:read permission, measured against a reference locale:

curl -H "Authorization: Bearer $MIDLANG_TOKEN" \
  http://127.0.0.1:4321/coverage/en
curl -H "Authorization: Bearer $MIDLANG_TOKEN" \
  "http://127.0.0.1:4321/coverage/en/de/missing?limit=50"

Next

The overview on the home page explains what MidLang is for, and ROADMAP.md in the repository tracks what is implemented and what is next.