Skip to content
Arxo Arxo

Installation

Installation

Section titled “Installation”

Prerequisites

Section titled “Prerequisites”
  • VS Code (or compatible editor such as VSCodium) 1.85 or later
  • arxo-lsp binary — the extension uses the Language Server Protocol and requires the arxo-lsp binary to run analysis

Install the Extension

Section titled “Install the Extension”
  1. From VSIX (local or CI): Download arxo-<version>.vsix from GitHub Releases, then in VS Code: Extensions → ⋯ → Install from VSIX → choose the file.
  2. From Marketplace (when published): Open the Extensions view, search for “Arxo”, and install.

Install arxo-lsp

Section titled “Install arxo-lsp”

The extension needs the arxo-lsp binary. When you install from a VSIX, the bundle may include a pre-built binary for your platform in its bin/ directory; the extension will use it automatically.

If the binary is not included or you need a different build, download the matching arxo-lsp binary for your platform from GitHub Releases, place it somewhere on your system, and set the extension setting arxo.lsp.serverPath to the full path to the binary.

Verify

Section titled “Verify”
  1. Open a TypeScript, JavaScript, Rust, Python, Java, Kotlin, or Go project.
  2. (Optional) Create an arxo.yaml in the project root — see Configuration.
  3. Save a file to trigger analysis. Violations appear in the Problems panel and in the Arxo sidebar.

If nothing appears, check that arxo.lsp.serverPath points to a valid arxo-lsp binary (when not using the bundled one) and that the extension output channel (Arxo) shows no errors.