Skip to main content

atmos lsp start

Use this command to start the Atmos Language Server Protocol (LSP) server for IDE integration. The LSP server provides syntax validation, auto-completion, and hover documentation for Atmos stack files.

Experimental

Configure LSP

Learn how to configure LSP server and client settings in your atmos.yaml.

atmos lsp start --help

Description​

The atmos lsp start command starts the Atmos LSP server, enabling IDE integration for Atmos stack files.

The LSP server provides:

  • Syntax validation and diagnostics
  • Auto-completion for Atmos keywords and components
  • Hover documentation for Atmos-specific syntax

The server supports multiple transport protocols for different use cases:

  • stdio — Standard input/output (default, for IDE integration)
  • tcp — TCP server for remote connections
  • websocket — WebSocket server for web-based editors

Usage​

atmos lsp start [flags]

Flags​

--transport
Transport protocol to use: stdio, tcp, or websocket (default: stdio)
--address
Address for tcp/websocket transports in host:port format (default: localhost:7777)

Examples​

# Start LSP server with stdio transport (default, for IDE integration)
atmos lsp start

# Start LSP server with TCP transport
atmos lsp start --transport=tcp

# Start LSP server with TCP on a custom address
atmos lsp start --transport=tcp --address=localhost:9999

# Start LSP server with WebSocket transport
atmos lsp start --transport=websocket --address=localhost:8080

Editor Setup​

VS Code​

Configure your VS Code LSP client to run the Atmos LSP server:

{
  "atmos.lsp.command": "atmos",
  "atmos.lsp.args": ["lsp", "start", "--transport=stdio"]
}

Other Editors​

For detailed editor-specific setup instructions, see the LSP Server Guide.