tree-sitter/cli
2024-10-26 23:53:58 +00: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 feat: add eslint configuration package 2024-09-22 20:26:04 -04:00
generate feat(lib): add the language name 2024-10-26 23:53:58 +00:00
loader docs(rust): document optional features 2024-10-24 17:08:55 +00:00
npm fix(dsl): fix types for RuleBuilder 2024-10-20 01:27:42 +00:00
src feat!: bump internal abi to 15 2024-10-26 17:02:00 +00:00
vendor Add a highlight subcommand 2019-02-19 12:32:03 -08:00
build.rs build(cli): get build sha via git command 2024-10-26 04:41:10 +00:00
Cargo.toml build: configure clippy lints at the workspace level 2024-10-08 21:07:41 -04:00
README.md chore: misc clippy lints 2024-10-06 17:55:00 -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 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.