tree-sitter/cli
2024-02-13 16:40:05 -05:00
..
benches feat: improve time reports 2024-02-07 03:19:02 -05:00
config chore: move dependencies into the workspace and inherit from there 2024-02-08 15:24:09 -05:00
loader refactor: extract regex check into a function and lower its precedence 2024-02-13 03:33:07 -05:00
npm fix(cli): installation via a HTTP tunnel proxy 2024-02-11 03:58:14 -05:00
src fix: properly handle Query.matches when filtering out results 2024-02-13 16:40:05 -05:00
vendor Add a highlight subcommand 2019-02-19 12:32:03 -08:00
build.rs chore(cli): apply clippy fixes 2024-02-04 04:18:48 -05:00
Cargo.toml feat: improve error message for files with an unknown grammar path 2024-02-12 17:17:37 -05:00
README.md docs: update badges; fix markdown lint complains 2023-04-16 23:39:08 +03:00

Tree-sitter CLI

crates.io badge npmjs.com badge

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.