Ways to run it
Pick the row that matches what you want; the three are alternatives, not steps.
The Docker stack is three containers: Postgres with pgvector, the server and the background worker. It serves the bundled web client at .
First local result
With Git and Docker Compose installed, run the local demo and check its seeded readings. Model features require a supported key in.env; the sample readings are available without one.
1
Start the demo
Clone the engine and start the stack. The script pulls the application image and creates demo accounts and example readings, then follows the service logs.
2
Check the services
When the script reports The
Up, keep that terminal open. In another terminal, run these commands from the engine checkout:mirobody service should become healthy, and the health response includes version and agent. The last command checks model features inside the container. If you add a model key to .env after startup, run docker compose up -d; docker compose restart does not re-read .env.3
Inspect the readings
Open , sign in as
you@mirobody.ai with code 111111, then open Data. The seeded readings should appear there. The Quickstart also covers demo upload files and the other run modes.Where the three stages live
The package is organized around the same three stages as this documentation.A reading moves through collection, standardization, and agent access.
How a single reading passes through all three is described in The Pipeline; the directory map is Repository Layout.
What a deployment serves
A self-hosted engine does not serve the Cloud
/v1 API. The Cloud tab documents that surface; the routes above are the engine’s own.
Next steps
Quickstart
Install the library, bring up the stack, or run a checkout.
Configuration
The model key, the configuration files, and the settings a deployment changes.
HTTP API
Get a local token, write a reading, and read it back.
Walkthrough
The running stack in four scenes, with the demo record.
Deploy on a Server
Production posture, secrets, HTTPS and a deployment check.
Upgrade a Deployment
Back up, review a release, upgrade and verify the running stack.
Verify and Restore a Backup
Rehearse a restore and recover Postgres and local uploads.
Contributing
The highest-leverage contribution is a term the resolver gets wrong. Runmirobody resolve "<term>"; if the answer is wrong or empty, report it, or add a row to together with a case in . The coverage score is the review.
A development checkout installs the test extra and runs the suite and the import contracts:
benchmarks/ run from a clone with no private data: python -m unittest benchmarks.health_records.test_cases (13 synthetic readings and 26 complaint phrases in five languages, checked against their LOINC/UCUM and ICPC-3 codes) and python -m unittest discover -s benchmarks/genomics -p 'test_*.py' (13 public 1000 Genomes calls in ten file shapes). See and .
GitHub repository
Source code, issues and pull requests.
Report a problem
A report that parses incorrectly makes a valuable issue; attach a de-identified sample.