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.