Quickstart

This walks through a full deployment with the CLI. It assumes you have installed the CLI and set api-url.

1. Log in

mikrom auth login --email <you@example.com> --password '<password>'
mikrom auth whoami

2. (Optional) select a project

Resources belong to a project. List them and switch context if you have more than one:

mikrom project list
mikrom project switch <slug>        # 6-char slug from the list

3. Create the app

Point the app at a public Git repository. The repo should either contain a Dockerfile or be a stack Railpack can detect (Node, Python/Django, PHP/Laravel, Go, Rust, Ruby/Rails, Elixir/Phoenix, or a static site).

mikrom app create --name my-app --git-url https://github.com/<user>/<repo>.git

The app is created with an automatic hostname, my-app.<apps-domain>.

4. Deploy

mikrom app deploy --name my-app --cpu 1 --memory 512M --watch

• --cpu is one of 1, 2, 3, 4 (default 1).
• --memory is one of 512M, 1G, 2G, 4G (default 512M).
• --watch streams progress until the deployment finishes.
• --hypervisor firecracker|cloud-hypervisor is optional; the scheduler chooses otherwise.

The build runs first (Docker or Railpack), then the scheduler places the deployment and the agent boots its microVM. On the first successful deploy the router publishes the app and requests a TLS certificate.

5. Check it

mikrom app deployments --name my-app     # history, newest first
mikrom deployment list                   # live deployments across all apps
mikrom app logs --name my-app --follow

Then open https://my-app.<apps-domain> in a browser.

6. Ship a change

Push to the repo and deploy again:

mikrom app deploy --name my-app --watch

Every deploy is retained. To go back to a previous one:

mikrom app deployments --name my-app                    # copy a deployment id
mikrom app activate --app my-app --deployment-id <id>

What next

• Deploying an app — the same flow in more depth.
• Apps and deployments — the lifecycle model.
• Storage — databases and volumes.