tree-sitter/cli
2024-12-15 23:05:54 -05:00
..
benches feat: add fuzz subcommand 2024-05-30 23:00:45 -04:00
config build: configure clippy lints at the workspace level 2024-10-08 21:07:41 -04:00
eslint build(deps): bump cross-spawn from 7.0.3 to 7.0.5 in /cli/eslint 2024-11-22 23:18:29 -05:00
generate fix: clippy lints 2024-11-16 03:20:59 -05:00
loader fix(cli): correct default query paths 2024-12-15 23:05:54 -05:00
npm fix(dsl): fix types for RuleBuilder 2024-10-20 01:27:42 +00:00
src fix(cli): count skipped tests correctly 2024-12-15 16:09:51 -05:00
vendor Add a highlight subcommand 2019-02-19 12:32:03 -08:00
build.rs fix: clippy lints 2024-11-16 03:20:59 -05:00
Cargo.toml feat(cli): add nushell completions 2024-12-10 19:35:58 -05:00
README.md docs(rust): add --locked to installation instructions 2024-10-30 10:51:46 -04: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 --locked 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.