# Install with the CLI Install the agent with mikroscope install over ssh, what it checks and writes in order, how it marks what it owns, and the flags and variables it reads. Source: https://docs.jmrp.io/mikroscope/install/ `mikroscope install` puts the agent on the router over ssh. It checks the router, reads its architecture, lists every RouterOS command, asks, writes, and probes the agent. Pick where the image comes from: - **Registry pull** ```sh mikroscope install --router admin@192.168.88.1 --remote-image jmrplens/mikroscope-agent:1.6.1 ``` The router pulls the image for its own architecture from the registry. Nothing is built or uploaded, and `/container/config` is not touched. The same image is on GHCR as `ghcr.io/jmrplens/mikroscope-agent:1.6.1`. - **From source** ```sh git clone https://github.com/jmrplens/mikroscope cd mikroscope make build bin/mikroscope install --router admin@192.168.88.1 ``` With neither `--remote-image` nor `--agent-tar`, the CLI builds the agent from the checkout: `go build ./cmd/mikroscope-agent` for the router's architecture with `CGO_ENABLED=0`, packed into an image tar without Docker, and uploaded with `scp`. It needs Go 1.27 and must run from the checkout; without Go on `PATH` it stops before anything is listed and names the other two routes. A router that cannot reach a registry takes the published image tar: [Offline install](https://docs.jmrp.io/mikroscope/install/offline/). ## Before you install - The router meets the [Requirements](https://docs.jmrp.io/mikroscope/install/prerequisites/): RouterOS 7.24 or later, the `container` package and `device-mode container=yes`. Run `mikroscope doctor --router admin@192.168.88.1` with the same flags you will install with; it writes nothing and names the fix for anything missing. - ssh reaches the router as an admin user with a key or an ssh agent. For a router not yet in `known_hosts`, add `--ssh-option StrictHostKeyChecking=accept-new`. - Choose where the image comes from: [Install methods](https://docs.jmrp.io/mikroscope/install/routes/) compares the routes. ## Install steps 1. **Reads the router.** `install` runs `doctor`'s checks in one connect and reads the router's architecture there (`--arch auto`, the default). A `MISSING` check stops it with `N prerequisite(s) missing; nothing was written`; a `WARN` is printed and does not. `--no-doctor` skips the checks; the architecture then takes one connect of its own, or none with `--remote-image`, where the router picks it from the image's index. 2. **Gets the image.** With `--remote-image` nothing is fetched. With `--agent-tar` it checks that the tar is a mikroscope agent image for the router's architecture and prints `using mikroscope-agent-amd64.tar: linux/amd64, agent KiB`. With neither it builds one from the checkout. 3. **Prints the plan.** One line of options (a token shows as `token=(set)`, never its value), the tag, then every RouterOS command numbered, the install manifest first. The container step names the upload with its size, or `the router pulls (nothing is uploaded)`. It ends with `nothing above has been written yet`. `mikroscope plan` and `install --dry-run` stop here without connecting, and assume `arm64` where the architecture matters. 4. **Asks** `write the objects above to the router? [y/N]`. `--yes` skips the question. 5. **Checks every step at once.** One connect asks, for each step, whether mikroscope's object is there and whether something else already holds it. A step already this install's prints `ok … (already present)` and is skipped. A step something else holds stops the install before the first write. 6. **Writes.** The install manifest first, then each object, one connect per write: ```text new install manifest mikroscope/mikroscope.manifest.txt new veth interface veth-mikroscope new router address 172.30.10.1 new interface-list membership LAN new address-list membership LANs pull the router pulls registry-1.docker.io/jmrplens/mikroscope-agent:1.6.1 itself new container mikroscope install done: 6 step(s) created ``` On the tar route the container step uploads the tar (`up uploading mikroscope.tar ( KiB)`), waits for RouterOS to extract it, up to `--extract-timeout` (120 s by default), then deletes the tar and starts the container. If extraction is not done by then, it stops and leaves the tar, which `uninstall` removes. 7. **Probes the agent** from your host and says which transport works: ```text probing http://172.30.10.2:9123/healthz from this host … direct transport ok: agent 1.6.1 () built