Skip to content

Installation

Recommended setup

Use Tua through the VS Code extension. Published extension packages include the matching Tua language server, so normal editor installation does not require Rust, Cargo, Node.js, or a separate server setup.

Install Tua from one of these channels:

The extension requires VS Code 1.94 or newer. Each published platform package contains the matching tua server binary and uses it automatically without downloading another executable during activation.

Start A Project

  1. Install the extension and open a project folder in VS Code.
  2. Run Tua: Initialize Tua Project from the command palette.
  3. Open src/main.tua and use normal completion, hover, diagnostics, inlay hints, navigation, and formatting.
  4. If LOVE 11.x is installed, run Tua: Run LOVE Project to build and launch the project from a visible VS Code task.

For an existing project, open the folder containing tua.toml. The extension starts the bundled server and discovers the project configuration automatically.

For source-mapped LOVE breakpoints, stepping, variables, and watches, continue with Debugging after installing the Tua extension.

Install A VSIX Manually

Download the VSIX matching your operating system and architecture from GitHub Releases. In VS Code, open the Extensions view, choose Install from VSIX..., and select the downloaded file.

Release assets include individual checksums and a SHA256SUMS manifest. See Releases And Compatibility for verification commands and the support policy.

Select Another Server

The bundled server is the default for published VSIX builds. To use a local or development binary instead, run Tua: Select Server or set tua.server.path. Unbundled development installs fall back to tua on PATH.

Standalone CLI Release

Tagged releases also provide standalone tua server/CLI archives for Linux x64, Windows x64, macOS Intel, and macOS Apple silicon. Choose the archive for your operating system and architecture from GitHub Releases, verify its checksum, and place the tua executable on PATH.

Use the standalone CLI when you want Tua in a terminal, build script, or editor other than VS Code.

Build The CLI From Source

Building from source requires Rust and Cargo. From the repository root:

cargo build -p tua-cli

The debug binary is written to:

target/debug/tua

For a release build:

cargo build --release -p tua-cli

During development, commands can run directly through Cargo:

cargo run -p tua-cli -- --help

For example:

cargo run -p tua-cli -- init
cargo run -p tua-cli -- check
cargo run -p tua-cli -- build

Repository contributors should use the setup and verification workflows in CONTRIBUTING.md.