Installation

ZiraDocs provides native, standalone binaries for macOS, Linux, and Windows. You can install the toolchain (slidelang and doclang) using your preferred method.

Using Homebrew (macOS & Linux)

The easiest way to install the tools on macOS and Linux is via the official Homebrew tap:

brew tap ziradocs/tap https://github.com/ziradocs/homebrew-tap

# Note: On recent Homebrew versions, you may need to explicitly trust the tap first:
brew trust ziradocs/tap

brew install slidelang doclang

This will install the latest version of both the slidelang and doclang CLIs to your system path.

Downloading Pre-compiled Binaries

Every ZiraDocs release publishes pre-compiled binaries for Intel and ARM architectures.

1. Go to the ZiraDocs Toolchain Releases page on GitHub.
2. Find the latest release (e.g., v2.0.0).
3. Download the archive for your operating system and architecture (e.g., slidelang_2.0.0_darwin_arm64.tar.gz for Apple Silicon Mac).
4. Extract the archive and place the slidelang / doclang binary in a directory included in your system’s PATH.

Compiling from Source (Using Go)

If you have Go installed on your system, you can build and install the CLIs directly from the source code:

# Install SlideLang
go install go.ziradocs.com/slidelang/cmd/slidelang@latest

# Install DocLang
go install go.ziradocs.com/doclang/cmd/doclang@latest

This method is recommended if you are developing themes, contributing to the core compiler, or if you prefer to build the binaries locally.

Installing AST TypeScript Types

If you are building custom tooling or agents that interact with ZiraDocs’ open JSON AST, you can install the TypeScript definitions via NPM:

npm install @ziradocs/ast-types