tree-sitter/cli
Max Brunsfeld a1fec71b19 Tweak QueryCursor to allow iterating either matches or captures
For syntax highlighting, we want to iterate over all of the captures in 
order, and don't care about grouping the captures by pattern.
2019-09-13 15:19:04 -07:00
..
benches Avoid printing names of all skipped tests in benchmark script 2019-08-06 12:46:46 -07:00
npm 0.15.8 2019-08-30 21:22:46 -07:00
src Tweak QueryCursor to allow iterating either matches or captures 2019-09-13 15:19:04 -07:00
vendor Add a highlight subcommand 2019-02-19 12:32:03 -08:00
build.rs tree-sitter-cli: build: add support for git submodules (#422) 2019-08-12 14:11:59 -07:00
Cargo.toml 0.15.8 2019-08-30 21:22:46 -07:00
README.md Update docs after Rust conversion 2019-02-05 11:34:01 -08:00

Tree-sitter CLI

Build Status Build status Crates.io

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 file) using Tree-sitter parsers.