Aexol Language

DocsAexol LanguageCLI & Tooling

Command-line tools for Aexol — parse, validate, generate docs, LSP support, and editor integration.

CLI & Tooling

The Aexol CLI provides commands for parsing, validating, and working with Aexol specifications from the terminal. It also includes an LSP server for editor integration.

Installation

npm install -g @aexol/spectral

Requires Node.js 20 or newer. Once installed, the aexol command becomes available globally.

CLI Commands

Command	Description
`aexol parse <file>`	Parse an Aexol file and display the AST structure
`aexol validate <file>`	Validate syntax, type references, and semantic structure
`aexol analyze <file>`	Generate a detailed analysis report with statistics and suggestions
`aexol docs <file> [-o output.md]`	Generate Markdown documentation from an Aexol spec
`aexol lsp [--info\|--stdio]`	Start the Language Server Protocol server for editor integration
`aexol auth login`	Authenticate with Aexol Cloud for remote generation features
`aexol update`	Update the CLI to the latest version
`aexol help`	Show all available commands

Examples

Validate a spec and catch errors before committing:

aexol validate app.aexol

Generate human-readable documentation from your spec:

aexol docs app.aexol -o docs/API.md

Inspect the parsed structure to debug type relationships:

aexol parse app.aexol

LSP — Editor Integration

Aexol includes a Language Server Protocol server that provides real-time diagnostics, autocompletion, and hover information in any LSP-compatible editor.

VS Code

Install the Aexol extension from the VS Code marketplace. It provides syntax highlighting, error squiggles, autocomplete, and go-to-definition out of the box.

Neovim

Add this to your LSP configuration:

require('lspconfig').aexol.setup{
  cmd = { 'aexol', 'lsp', '--stdio' },
  filetypes = { 'aexol' },
}

Other Editors

Any editor with LSP support (Helix, Emacs, Zed, Sublime Text) can use the Aexol LSP by running:

aexol lsp --stdio

Configure your editor to launch this command for files with the .aexol extension.

Next Steps

Spectral Agent — The always-on coding agent that runs on your machine and works with Aexol specs
Studio Overview — Browser-based IDE with real-time validation, code generation, and team collaboration