tree-sitter-cli

Tree-sitter CLI

The Tree-sitter CLI allows you to develop, test, and use Tree-sitter grammars from the command line. It works on MacOS, Linux, and Windows.

Installation

You can install the tree-sitter-cli with cargo:

cargo install tree-sitter-cli

or with npm:

npm install tree-sitter-cli

You can also download a pre-built binary for your platform from the releases page.

Dependencies

The tree-sitter binary itself has no dependencies, but specific commands have dependencies that must be present at runtime:

• To generate a parser from a grammar, you must have node on your PATH.
• To run and test parsers, you must have a C and C++ compiler on your system.

Commands

• generate - The tree-sitter generate command will generate a Tree-sitter parser based on the grammar in the current working directory. See the documentation for more information.

• test - The tree-sitter test command will run the unit tests for the Tree-sitter parser in the current working directory. See the documentation for more information.

• parse - The tree-sitter parse command will parse a file (or list of files) using Tree-sitter parsers.

Changelog

[0.22.6] — 2024-05-05

Features

• Improve handling of serialization buffer overflows (https://github.com/tree-sitter/tree-sitter/pull/3318)
• Reverse iteration through node parents (https://github.com/tree-sitter/tree-sitter/pull/3214)
• cli: Support NO_COLOR (https://github.com/tree-sitter/tree-sitter/pull/3299)
• cli: Add test listing and allow users to parse a specific test number (https://github.com/tree-sitter/tree-sitter/pull/3067)
• grammar: Add "inherits" field if available (https://github.com/tree-sitter/tree-sitter/pull/3295)

Bug Fixes

• Correctly load field data from wasm languages
• Improve error message when the tree-sitter field is malformed
• Don't error out on package.json lookup errors if --no-bindings is passed (https://github.com/tree-sitter/tree-sitter/pull/3323)
• cli: Keep default cc flags in build
• cli: Properly account for multi-grammar repos when using docker to build a wasm parser (https://github.com/tree-sitter/tree-sitter/pull/3337)
• generate: Don't check arbitrarily named dirs
• generate: Take AsRef<Path> for the path parameter to avoid clones (https://github.com/tree-sitter/tree-sitter/pull/3322)
• highlight: Correct signature of ts_highlighter_add_language
• lib: Do not return field names for extras (https://github.com/tree-sitter/tree-sitter/pull/3330)
• lib: Advance the lookahead end byte by 4 when there's an invalid code point (https://github.com/tree-sitter/tree-sitter/pull/3305)
• rust: Update README example (https://github.com/tree-sitter/tree-sitter/pull/3307)
• rust: Use unix + wasi cfg instead of not windows for fd (https://github.com/tree-sitter/tree-sitter/pull/3304)
• test: Allow newlines in between test name and attribute
• wasm: Correct childrenFromFieldXXX method signatures (https://github.com/tree-sitter/tree-sitter/pull/3301)
• xtask: Always bump every crate in tandem
• zig: Make usable as a zig dependency (https://github.com/tree-sitter/tree-sitter/pull/3315)

Documentation

• Mention build command variables
• Swap \s for \\s in query example
• highlight: Typo (https://github.com/tree-sitter/tree-sitter/pull/3290)

Refactor

• tests: Migrate remaining grammar.json tests to grammar.js (https://github.com/tree-sitter/tree-sitter/pull/3325)

Build System and CI

• Add nightly rustfmt to workflow for linting (https://github.com/tree-sitter/tree-sitter/pull/3333)
• Fix address sanitizer step (https://github.com/tree-sitter/tree-sitter/pull/3188)
• deps: Bump cc from 1.0.92 to 1.0.94 in the cargo group (https://github.com/tree-sitter/tree-sitter/pull/3298)
• deps: Bump the cargo group with 6 updates (https://github.com/tree-sitter/tree-sitter/pull/3313)
• xtask: Bump build.zig.zon version when bumping versions