Install and authenticate
miosa is the official MIOSA command line tool. There is one miosa CLI: version 2.2. It runs on macOS, Linux and Windows.
Install
Verify
miosa --version
miosa version These print 2.2.0. If they print 1.x, run npm i -g @miosa/cli@latest or brew upgrade to move onto the 2.x line.
Windows
The npm install is the simplest path on Windows: npm i -g @miosa/cli resolves the win32-x64 build (@miosa/cli-win32-x64) and puts miosa on your PATH.
To install by hand, download miosa_2.2.0_windows_amd64.zip from GitHub Releases, extract miosa.exe, and add its folder to your PATH. In PowerShell:
$dir = "$env:USERPROFILEmiosa"
Expand-Archive -Path "$env:USERPROFILEDownloadsmiosa_2.2.0_windows_amd64.zip" -DestinationPath $dir
[Environment]::SetEnvironmentVariable("Path", "$env:Path;$dir", "User")
# open a new terminal, then
miosa --version SetEnvironmentVariable with the User scope makes the change permanent without admin rights; it only affects terminals opened after you run it. For the current session only, use $env:Path += ";$dir" instead.
Windows builds are x64 only. There is no windows/arm64 archive.
Upgrading from 1.x
1.x was the Node CLI. 2.x is the same miosa command with a rewritten command surface, and the installs above now all give you 2.2.x.
What changed:
- Sandbox commands lost the
sandboxprefix.miosa sandbox createis nowmiosa create. - Deployment work moved under
miosa deploy. The oldmiosa appand top-levelreleases,rollbackandbuildscommands are nowmiosa deploysubcommands. New in 2.2:miosa deploy createpublishes a sandbox, a git repository or a local directory. - Contexts became profiles.
miosa contextis nowmiosa profile, stored in~/.miosa/config.toml. - Restored in 2.1. Several 1.x command families came back, renamed:
miosa device(any runtime kind),miosa mcp, and themiosa hostfamilies for containers, meshes, GitHub Actions runners, backups and tunnels. - Still removed from the public CLI: the internal OSA tooling
actions,blueprint,changes,drift,evidence,capabilitiesandcommand-overview. Action authority is server-side, andmiosa --helpreplacescommand-overview.
Renamed commands:
| 1.x | 2.2 |
|---|---|
miosa sandbox create | miosa create |
miosa sandbox exec | miosa exec |
miosa sandbox stop / resume | miosa stop / miosa resume |
miosa sandbox fork | miosa fork |
miosa sandbox wait | miosa wait |
miosa sandbox prompt | miosa prompt |
miosa sandbox write-file | miosa files write |
miosa sandbox dev | miosa console |
miosa sandbox doctor | miosa doctor |
miosa sandbox publish | miosa deploy |
miosa ls | miosa list |
miosa rm | miosa destroy |
miosa cp | miosa files cp |
miosa watch | miosa events |
miosa context | miosa profile |
miosa app link / promote / rollback | miosa deploy (promote, rollback) |
miosa releases | miosa deploy releases |
miosa rollback | miosa deploy rollback |
miosa builds | miosa deploy builds |
miosa deploy destroy | miosa deploy rm |
miosa deploy domain | miosa deploy domains / miosa deploy domain-add |
miosa deploy env | miosa deploy env / miosa deploy env-set |
miosa databases | miosa db |
miosa api-keys | miosa api-key |
miosa checkpoints | miosa checkpoint |
miosa templates | miosa template |
miosa schedules / miosa cron | miosa schedule |
miosa connectors | miosa connections |
miosa workspaces / miosa teams | miosa workspace |
miosa devices | miosa device |
miosa opencomputers | miosa host |
miosa containers | miosa host container |
miosa meshes | miosa host mesh |
miosa gha-runners | miosa host gha-runner |
miosa backups | miosa host backup (snapshots under miosa host backup snapshot) |
miosa tunnel open | miosa host tunnel |
miosa mcp ... | miosa mcp ... (restored in 2.1) |
miosa capabilities | miosa catalog |
miosa command-overview | miosa --help |
miosa actions ... | removed (authority is server-side) |
Update
miosa update # download and replace the binary
miosa update --check # report only
miosa version miosa update verifies the SHA-256 of the download against the release checksums.txt, and refuses to replace a Homebrew-managed binary (use brew upgrade there). A one-line notice appears at most once a day when a newer version exists; silence it with --no-update-notice or MIOSA_NO_UPDATE_NOTICE=1.
Shell completion
miosa completion zsh # bash, fish, powershell Sandbox names, profiles, templates and agents complete from the live API.
Sign in
miosa login # opens the browser, device-code sign in
miosa whoami # organization, plan, credits, and the scopes your key holds miosa whoami shows the user, organization, workspace, plan and the scopes the key holds.
Sign in with a key
miosa login --with-key asks for a key with hidden input, and --key-stdin reads it from stdin. A key is never accepted as an argument.
miosa login --with-key
echo "$MIOSA_KEY" | miosa login --key-stdin Credential resolution
Credentials resolve in this order:
--api-keyMIOSA_API_KEY- the active profile in
~/.miosa/config.toml
Sign out
miosa logout Removes the stored key of the active profile. miosa logout --all deletes the config file for every profile.
Diagnose
miosa doctor Checks configuration, connectivity and authentication, and prints a fix for each failure.