Installation

What you'll learn

• The four ways to add tree-sitter.zig 0.0.1 (current stable) to your project.
• How to install the latest development snapshot.
• How to wire the module into your build.zig.

Method 1: Zig Fetch (Recommended)

Latest Stable Release (v0.0.1)

zig fetch --save https://github.com/muhammad-fiaz/tree-sitter.zig/archive/refs/tags/0.0.1.tar.gz

WARNING

tree-sitter.zig requires Zig 0.16.0 exactly. New projects should use Zig 0.16.0 with tree-sitter.zig v0.0.1.

Method 2: Zig Fetch (Latest / in development)

Use this for the latest in-development version from the main branch:

zig fetch --save git+https://github.com/muhammad-fiaz/tree-sitter.zig.git

Method 3: Manual build.zig.zon Configuration

.dependencies = .{
    .treesitter = .{
        .url = "https://github.com/muhammad-fiaz/tree-sitter.zig/archive/refs/tags/0.0.1.tar.gz",
        .hash = "...", // Run `zig fetch --save <url>` to generate the hash.
    },
},

Method 4: Local Source Checkout

git clone https://github.com/muhammad-fiaz/tree-sitter.zig.git
cd tree-sitter.zig
zig build
zig build test

To use a local checkout from another project:

.dependencies = .{
    .treesitter = .{
        .path = "../tree-sitter.zig",
    },
},

Wire into build.zig

const treesitter_dep = b.dependency("treesitter", .{
    .target = target,
    .optimize = optimize,
});
exe.root_module.addImport("treesitter", treesitter_dep.module("treesitter"));

Useful commands:

zig build test       # full test suite
zig build examples   # all runnable examples
zig build bench      # benchmark (add -Doptimize=ReleaseFast)
zig build docs       # native Zig autodoc into zig-out/docs

Prebuilt Library

Release archives (.tar.gz source snapshots such as 0.0.1.tar.gz) are published on the Releases page. To vendor manually, extract the archive and expose its src/treesitter.zig as a module:

const treesitter_mod = b.createModule(.{
    .root_source_file = b.path("vendor/tree-sitter.zig-0.0.1/src/treesitter.zig"),
    .target = target,
    .optimize = optimize,
});
exe.root_module.addImport("treesitter", treesitter_mod);

Verifying the installation

const treesitter = @import("treesitter");
comptime {
    if (!std.mem.eql(u8, treesitter.version, "0.0.1")) @compileError("unexpected treesitter version");
}

Continue with Project Setup or jump to Your First Parser.

Related API

• Allocator — what the dependency needs from your program (one allocator, once).