Server
Run the HTTP API and MCP server, read its logs, and dump the CLI and API definitions.
Run the HTTP API and MCP server, read its logs, and dump the CLI and API definitions.
| Command | Description |
|---|---|
lume serve | Start the VM management server. |
lume logs | View lume serve logs. |
lume logs info | View info logs from the daemon. |
lume logs error | View error logs from the daemon. |
lume logs all | View both info and error logs from the daemon. |
lume dump-docs | Output CLI and API documentation as JSON for tooling and integrations. |
Every command also accepts the global options.
lume serve#Start the VM management server.
Serves the HTTP API on localhost, or with --mcp an MCP server over stdio for AI agents.
lume serve [OPTIONS]| Flag | Type | Default | Description |
|---|---|---|---|
--port | integer | 7777 | Port to listen on (HTTP mode only). |
--mcp | boolean | false | Run as an MCP server (stdio transport) for AI agents. |
Examples
# HTTP API on http://localhost:7777
lume serve
lume serve --port 7778
# MCP server over stdio (what MCP clients launch)
lume serve --mcplume logs#View lume serve logs.
lume logs <COMMAND>lume logs info#View info logs from the daemon.
lume logs info [OPTIONS]| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--lines | -l | integer | Number of lines to display from the end of the file. | |
--follow | -f | boolean | false | Follow the log continuously (like tail -f). |
Examples
lume logs info --lines 100
lume logs info --followlume logs error#View error logs from the daemon.
lume logs error [OPTIONS]| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--lines | -l | integer | Number of lines to display from the end of the file. | |
--follow | -f | boolean | false | Follow the log continuously (like tail -f). |
Examples
lume logs error --lines 100
lume logs error --followlume logs all#View both info and error logs from the daemon.
lume logs all [OPTIONS]| Flag | Short | Type | Default | Description |
|---|---|---|---|---|
--lines | -l | integer | Number of lines to display from the end of each file. | |
--follow | -f | boolean | false | Follow the log continuously (like tail -f). |
Examples
lume logs all --lines 100
lume logs all --followlume dump-docs#Output CLI and API documentation as JSON for tooling and integrations.
Emits the CLI, HTTP API or MCP tool metadata (arguments, options, flags, endpoints, tool schemas, help text, defaults and types) that the generated reference is built from.
lume dump-docs [OPTIONS]| Flag | Type | Default | Description |
|---|---|---|---|
--type | cli | api | mcp | all | cli | Documentation type to output. |
--pretty | boolean | false | Pretty-print the JSON output with sorted keys. |
Examples
lume dump-docs --type cli --pretty
# The MCP server's tool list
lume dump-docs --type mcp| Code | Meaning |
|---|---|
0 | Success. |
1 | The command failed (for example the VM does not exist or the operation errored). |
64 | Usage error: an unknown command or option, a missing argument, or an invalid value. |