tree-sitter/cli
2021-09-03 13:29:03 -07:00
..
benches cli: Extract CLI configuration into separate crate 2021-06-10 10:21:22 -04:00
config Merge pull request #1234 from ahlinc/fix/imrove-config-loading-err-msgs 2021-07-15 20:37:40 -07:00
loader Bump lib tree-sitter dependency versions in loader crate 2021-09-03 13:29:03 -07:00
npm chore(cli): Add the LICENSE file to the tree-sitter-cli npm package 2021-08-22 03:13:46 +03:00
src Fix possible infinite loop when running syntax highlighting tests 2021-08-29 15:04:23 -07:00
vendor Add a highlight subcommand 2019-02-19 12:32:03 -08:00
build.rs Merge branch 'master' into fix/1032 2021-06-29 15:59:15 -07:00
Cargo.toml Update smallbitvec dependency 2021-08-08 21:45:43 +02: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.