Nuanced LSP runs as a Docker container. The following outlines the API for starting, stopping, modifying the container environment, viewing logs, and managing the Nuanced LSP Docker container and image.
| Command | Description |
|---|
| Up | Start the container. |
| Down | Stop the container. |
| Logs | View the container logs. |
| Pull | Pull the nuanced-lsproxy image. |
| Run | Run a script within the container environment. |
| Status | Check the status of the container. |
The Pull command is useful for pre-pulling the nuanced-lsproxy image for faster startup times, or to update to the latest version.
> nuanced-lsp up /path/to/workspace
Arguments
| Argument | Description | Required |
|---|
workspace | Path to the host workspace to mount within the Nuanced LSP container | ✅ |
CLI options
| Option | Description | Default |
|---|
--host-port <n> | Host port to bind to container process | 4444 |
--bind-host <host> | Host/IP to bind (e.g. 127.0.0.1, 0.0.0.0, 192.168.1.10) | "127.0.0.1" |
--image <ref> | Docker image to use for standing up the container process | "ghcr.io/nuanced-dev/nuanced-lsproxy:<version>" |
--container-name <name> | Container name | "nuanced-lsp" |
--timeout <s> | Health check poll loop timeout seconds (<=0 to skip) | 120 |
--sudo | Docker commands are executed with sudo | Docker commands are executed without sudo |
--stream | Process stdout, stderr, and container logs are streamed to the CLI’s stdout | Process stdout, stderr, and container logs are not streamed |
--ro | Mount workspace as read-only | Mount workspace is read-write |
--json | Output machine readable JSON | Text output |
--debug | Enable debug log level for container process | Process log level is info |
Result
Success result confirms the container is running and bound to the specified host and port:Nuanced LSP container 'nuanced-lsp' bound at 127.0.0.1:4444
Down
Stops the Nuanced LSP container.
CLI options
| Option | Description | Default |
|---|
--container-name <name> | Container name | "nuanced-lsp" |
--timeout <s> | Timeout seconds (<=0 to skip) | 120 |
--sudo | Docker commands are executed with sudo | Docker commands are executed without sudo |
--json | Output machine readable JSON | Text output |
Result
Success result confirms the container was stopped:Nuanced LSP Stopped container 'nuanced-lsp'.
Logs
Print logs from the Nuanced LSP container.
CLI options
| Option | Description | Default |
|---|
--container-name <name> | Container name | "nuanced-lsp" |
--timeout <s> | Timeout seconds (<=0 to skip) | 120 |
--sudo | Docker commands are executed with sudo | Docker commands are executed without sudo |
--stream | Process stdout, stderr, and container logs are streamed to the CLI’s stdout | Process stdout, stderr, and container logs are not streamed |
--since <when> | Only show logs since (e.g. 10s, 5m, or RFC3339 timestamp) | — |
--tail <n|all> | Show last N lines, or all for full history | — |
--json | Output machine readable JSON | Text output |
Result
On success, logs are printed to stdout.Example:[2025-09-02T17:02:11Z] Starting Nuanced LSP...
[2025-09-02T17:02:12Z] Listening on 127.0.0.1:4444
Pull
Pull the Nuanced LSP image.
CLI options
| Option | Description | Default |
|---|
--image <ref> | Nuanced LSP Docker image to pull | "ghcr.io/nuanced-dev/nuanced-lsproxy:<version>" |
--sudo | Docker commands are executed with sudo | Docker commands are executed without sudo |
--stream | Process stdout, stderr, and container logs are streamed to the CLI’s stdout | Process stdout, stderr, and container logs are not streamed |
--json | Output machine readable JSON | Text output |
Result
On success, the image is pulled and confirmation is shown.Example:Pulled image ghcr.io/nuanced-dev/nuanced-lsproxy:0.3.8
Run
Run a script inside the Nuanced LSP container.
The script is copied to the container and is executed within the container as the root user.
> nuanced-lsp run ./scripts/setup.sh
Arguments
| Argument | Description | Required |
|---|
script | Path to a script to copy to the container and execute | ✅ |
CLI options
| Option | Description | Default |
|---|
--container-name <name> | Container name | "nuanced-lsp" |
--timeout <s> | Timeout seconds (<=0 to skip) | 120 |
--sudo | Docker commands are executed with sudo | Docker commands are executed without sudo |
--stream | Process stdout, stderr, and container logs are streamed to the CLI’s stdout | Process stdout, stderr, and container logs are not streamed |
--json | Output machine readable JSON | Text output |
Result
On success:Script executed successfully in nuanced-lsp.
Status
Show the container lifecycle status of the Nuanced LSP container.
This command does not perform a /health probe. It only checks Docker’s view of the container.
CLI options
| Option | Description | Default |
|---|
--json | Output raw JSON | — |
--container-name <name> | Container name | "nuanced-lsp" |
--timeout <s> | Timeout seconds (<=0 to skip) | 120 |
--sudo | Docker commands are executed with sudo | Docker commands are executed without sudo |
--json | Output machine readable JSON | Text output |
Result
Default output:Container: nuanced-lsp
Running: yes
Docker: Up 29 minutes
--json:{
"container_name": "nuanced-lsp",
"running": true,
"container_status": "Up 28 minutes"
}
