> ## Documentation Index > Fetch the complete documentation index at: https://docs.make87.com/llms.txt > Use this file to discover all available pages before exploring further. # CLI Reference > Complete command reference for the m87 CLI ## Global Flags Enable verbose logging output ## Top-Level Commands ### Authentication #### `m87 login` Authenticate with make87 via browser-based OAuth flow. ```bash theme={null} m87 login ``` #### `m87 logout` Logout and clear local credentials. ```bash theme={null} m87 logout ``` ### Device Management #### `m87 devices list` List all accessible devices. ```bash theme={null} m87 devices list ``` #### `m87 devices approve ` Approve a pending device registration. Device name or ID to approve ```bash theme={null} m87 devices approve my-device ``` #### `m87 devices reject ` Reject a pending device registration. Device name or ID to reject ```bash theme={null} m87 devices reject my-device ``` #### `m87 devices show ` Show detailed information about a specific device. Device name or ID ```bash theme={null} m87 devices show my-device ``` This command is not yet fully implemented. ### File Operations #### `m87 cp ` Copy files between local and remote devices (SCP-style). Source path. Use `:` for remote, `` for local. Destination path. Use `:` for remote, `` for local. ```bash theme={null} # Copy from device to local m87 cp my-device:/var/log/app.log ./app.log # Copy from local to device m87 cp ./config.yml my-device:/etc/app/config.yml ``` #### `m87 sync ` Sync files between local and remote devices (rsync-style). Source path. Use `:` for remote, `` for local. Destination path. Use `:` for remote, `` for local. Delete files from destination that are not present in source Watch for changes and sync automatically Show what would be done without making changes Exclude files matching pattern (can be used multiple times) ```bash theme={null} # Sync directory to device m87 sync ./src my-device:/app/src # Sync with delete flag m87 sync --delete ./src my-device:/app/src # Watch mode with exclusions m87 sync --watch --exclude "*.log" --exclude "node_modules" ./src my-device:/app/src ``` #### `m87 ls ` List files on a device. Remote path in format `:` ```bash theme={null} m87 ls my-device:/var/log ``` ### Utility Commands #### `m87 version` Show CLI version information including build details and platform. ```bash theme={null} m87 version ``` #### `m87 update` Update the CLI to the latest version. ```bash theme={null} m87 update ``` ### Configuration #### `m87 config set` Set configuration values. Override API URL (e.g., [https://eu.public.make87.dev](https://eu.public.make87.dev)) Set owner reference (email or org ID) Set make87 API URL Set make87 app URL Trust invalid server certificates (use with caution) ```bash theme={null} m87 config set --runtime-server-url https://eu.public.make87.dev m87 config set --owner-reference myorg ``` #### `m87 config show` Display current configuration. ```bash theme={null} m87 config show ``` #### `m87 config file` Show path to configuration file. ```bash theme={null} m87 config file ``` ### SSH Commands #### `m87 ssh enable` Enable SSH host resolution for `.m87` domains. ```bash theme={null} m87 ssh enable ``` After enabling, you can use standard SSH: ```bash theme={null} ssh my-device.m87 ``` #### `m87 ssh disable` Disable SSH host resolution. ```bash theme={null} m87 ssh disable ``` ### MCP Server #### `m87 mcp` Start MCP server (Model Context Protocol) for AI agent integration. The server runs on stdin/stdout and exposes m87 platform commands as MCP tools. ```bash theme={null} m87 mcp ``` See [MCP Overview](/api/mcp-overview) for configuration details. ## Device Commands Device commands follow the pattern `m87 `. These commands operate on a specific device. ### `m87 shell` Open an interactive shell on the device. ```bash theme={null} m87 my-device shell ``` ### `m87 exec` Execute a command on the device. Keep stdin open (for responding to prompts) Allocate a pseudo-TTY (for TUI apps like vim, htop) Command and arguments to execute (use `--` before command) ```bash theme={null} # Simple command m87 my-device exec -- ls -la # Interactive command m87 my-device exec -it -- vim config.yml # Command with pipes m87 my-device exec -- "ps aux | grep nginx" ``` ### `m87 forward` Forward remote port(s) to localhost. Port forwarding specifications. Supports: * Single port: `8080` * Port mapping: `3000:8080` (local:remote) * Port range: `8080-8090` * Range mapping: `8080-8090:9080-9090` * With host: `8080:192.168.1.50:9080` * With protocol: `8080/udp` (default: tcp) ```bash theme={null} # Forward single port m87 my-device forward 8080 # Forward to different local port m87 my-device forward 3000:8080 # Forward multiple ports m87 my-device forward 8080 9090 3000 # Forward port range m87 my-device forward 8080-8090 # Forward to specific host on device network m87 my-device forward 8080:192.168.1.50:9080 # UDP forwarding m87 my-device forward 8080/udp ``` ### `m87 docker` Run docker commands on the device. Docker CLI arguments (passed through to docker command) ```bash theme={null} # List containers m87 my-device docker ps # List all containers m87 my-device docker ps -a # Run a container m87 my-device docker run -d nginx # Execute in container m87 my-device docker exec -it my-container bash # View logs m87 my-device docker logs my-container ``` ### `m87 logs` Stream container logs from the device. Follow log output Number of lines to show from end of logs ```bash theme={null} # View last 100 lines m87 my-device logs # Follow logs m87 my-device logs -f # Show last 50 lines m87 my-device logs --tail 50 ``` ### `m87 metrics` Show device system metrics (CPU, memory, disk, network). ```bash theme={null} m87 my-device metrics ``` Alias: `m87 stats` ### `m87 status` Show device status including health, crashes, and incidents. ```bash theme={null} m87 my-device status ``` ### `m87 audit` View audit logs showing who interacted with the device. End time in RFC 3339 format (e.g., 2026-01-31 or 2026-01-31T13:00:00) Start time in RFC 3339 format Maximum number of log entries Show detailed audit information ```bash theme={null} # Recent audit logs m87 my-device audit # Last 50 entries with details m87 my-device audit --max 50 --details # Time range query m87 my-device audit --since 2026-01-01 --until 2026-01-31 ``` ### `m87 serial` Connect to a serial device. Path to serial device (e.g., /dev/ttyUSB0) Baud rate for serial connection ```bash theme={null} # Connect with default baud rate m87 my-device serial /dev/ttyUSB0 # Connect with custom baud rate m87 my-device serial /dev/ttyUSB0 9600 ``` ## Deployment Commands Deployment commands manage asynchronous job execution on devices. ### `m87 deploy` Add a run spec to a deployment. Path to deployment file (docker-compose.yml or run spec YAML) Spec type: `auto`, `compose`, `runspec`, `deployment` Optional display name for the run spec Add to a specific deployment (otherwise uses active deployment) ```bash theme={null} # Deploy docker-compose file m87 my-device deploy ./docker-compose.yml # Deploy with custom name m87 my-device deploy ./my-app.yml --name "production-app" # Deploy to specific deployment m87 my-device deploy ./app.yml --deployment-id dep-123 # Force spec type m87 my-device deploy ./custom.yml --type runspec ``` ### `m87 undeploy` Remove a run spec from a deployment. Job ID or name to remove Remove from specific deployment (otherwise uses active deployment) ```bash theme={null} m87 my-device undeploy my-app m87 my-device undeploy my-app --deployment-id dep-123 ``` ### `m87 deployment list` List all deployments for the device. ```bash theme={null} m87 my-device deployment list ``` ### `m87 deployment new` Create a new deployment. Make this deployment active immediately ```bash theme={null} # Create inactive deployment m87 my-device deployment new # Create and activate m87 my-device deployment new --active ``` ### `m87 deployment show` Show deployment details including run specs. Specific deployment to show (defaults to active deployment) Output as YAML instead of formatted display ```bash theme={null} # Show active deployment m87 my-device deployment show # Show specific deployment m87 my-device deployment show --deployment-id dep-123 # Show as YAML m87 my-device deployment show --yaml ``` ### `m87 deployment status` Get deployment execution status. Specific deployment (defaults to active deployment) Show logs from deployment steps ```bash theme={null} # Status of active deployment m87 my-device deployment status # Status with logs m87 my-device deployment status --logs # Status of specific deployment m87 my-device deployment status --deployment-id dep-123 ``` ### `m87 deployment active` Print the currently active deployment ID. ```bash theme={null} m87 my-device deployment active ``` ### `m87 deployment activate` Set the active deployment. Deployment ID to activate ```bash theme={null} m87 my-device deployment activate dep-123 ``` ### `m87 deployment rm` Remove a deployment. Deployment ID to remove Skip confirmation prompt ```bash theme={null} m87 my-device deployment rm dep-123 m87 my-device deployment rm dep-123 --force ``` ### `m87 deployment clone` Clone an existing deployment into a new one. Source deployment ID to clone Make the cloned deployment active immediately ```bash theme={null} m87 my-device deployment clone dep-123 m87 my-device deployment clone dep-123 --active ``` ### `m87 deployment update` Update a deployment (remove/replace/rename specs). Deployment to update (defaults to active) Remove job(s) by ID (can be used multiple times) Replace job: `=` (can be used multiple times) Rename job: `=` (can be used multiple times) Enable job(s) by ID (can be used multiple times) Disable job(s) by ID (can be used multiple times) Spec type for replacements: `auto`, `compose`, `runspec` ```bash theme={null} # Remove a job m87 my-device deployment update --rm old-app # Replace a job m87 my-device deployment update --replace my-app=./new-version.yml # Rename a job m87 my-device deployment update --rename my-app=production-app # Enable/disable jobs m87 my-device deployment update --enable app1 --disable app2 # Combine operations m87 my-device deployment update --rm old-app --replace app=./new.yml --enable new-app ``` ## Device Access Control ### `m87 access list` List users with access to the device. ```bash theme={null} m87 my-device access list ``` ### `m87 access add` Grant access to a user or organization. Email address or organization ID Role: `admin`, `editor`, or `viewer` ```bash theme={null} m87 my-device access add user@example.com editor m87 my-device access add my-org admin ``` ### `m87 access remove` Revoke access from a user or organization. Email address or organization ID ```bash theme={null} m87 my-device access remove user@example.com ``` ### `m87 access update` Update user or organization role. Email address or organization ID New role: `admin`, `editor`, or `viewer` ```bash theme={null} m87 my-device access update user@example.com admin ``` ## Organization Commands ### `m87 org list` List all organizations. ```bash theme={null} m87 org list ``` ### `m87 org create` Create a new organization. Organization ID Email of organization owner ```bash theme={null} m87 org create my-org owner@example.com ``` ### `m87 org delete` Delete an organization. Organization ID to delete ```bash theme={null} m87 org delete my-org ``` ### `m87 org update` Update organization ID. Current organization ID New organization ID ```bash theme={null} m87 org update my-org new-org-name ``` ### Organization Members #### `m87 org members list` List organization members. Organization ID (auto-resolved if omitted) ```bash theme={null} m87 org members list m87 org members list --org-id my-org ``` #### `m87 org members add` Add a member to the organization. Member email address Role: `admin`, `editor`, or `viewer` Organization ID (auto-resolved if omitted) ```bash theme={null} m87 org members add user@example.com editor m87 org members add admin@example.com admin --org-id my-org ``` #### `m87 org members update` Update a member's role. Member email address New role: `admin`, `editor`, or `viewer` Organization ID (auto-resolved if omitted) ```bash theme={null} m87 org members update user@example.com admin ``` #### `m87 org members remove` Remove a member from the organization. Member email address Organization ID (auto-resolved if omitted) ```bash theme={null} m87 org members remove user@example.com ``` ### Organization Devices #### `m87 org devices list` List devices owned by the organization. Organization ID (auto-resolved if omitted) ```bash theme={null} m87 org devices list m87 org devices list --org-id my-org ``` #### `m87 org devices add` Add a device to the organization. Device name or ID Organization ID (auto-resolved if omitted) ```bash theme={null} m87 org devices add my-device m87 org devices add my-device --org-id my-org ``` #### `m87 org devices remove` Remove a device from the organization. Device name or ID Organization ID (auto-resolved if omitted) ```bash theme={null} m87 org devices remove my-device m87 org devices remove my-device --org-id my-org ``` ## Runtime Commands (Linux Only) These commands manage the m87 runtime service on Linux devices. Most require root privileges and automatically invoke `sudo`. ### `m87 runtime login` Register this device as a runtime (headless flow, requires approval). Organization ID to register runtime under (mutually exclusive with --email) Email address to register runtime under (mutually exclusive with --org-id) ```bash theme={null} m87 runtime login --email you@example.com m87 runtime login --org-id my-org ``` After registration, approve from your workstation with `m87 devices approve `. ### `m87 runtime logout` Logout and deauthenticate the runtime. ```bash theme={null} m87 runtime logout ``` ### `m87 runtime run` Run the runtime daemon (blocking, used by systemd service). Organization ID to register runtime under Email address to register runtime under ```bash theme={null} m87 runtime run --email you@example.com ``` ### `m87 runtime start` Start the runtime service now. Organization ID to register runtime under Email address to register runtime under ```bash theme={null} sudo m87 runtime start ``` ### `m87 runtime stop` Stop the runtime service now. ```bash theme={null} sudo m87 runtime stop ``` ### `m87 runtime restart` Restart the runtime service. Organization ID to register runtime under Email address to register runtime under ```bash theme={null} sudo m87 runtime restart ``` ### `m87 runtime enable` Configure service to auto-start on boot. Enable AND start service immediately Organization ID to register runtime under Email address to register runtime under ```bash theme={null} sudo m87 runtime enable sudo m87 runtime enable --now ``` ### `m87 runtime disable` Remove auto-start on boot. Disable AND stop service immediately ```bash theme={null} sudo m87 runtime disable sudo m87 runtime disable --now ``` ### `m87 runtime status` Show local runtime service status. ```bash theme={null} m87 runtime status ```