tree-sitter/cli
Daumantas Kavolis e26e23fd0e
Fix formatting
2023-10-25 10:24:35 +03:00
..
benches fix(test): stick tree-sitter-cpp fixture grammar to a specific hash 2023-05-13 18:57:42 +03:00
config doc: Include README as top-level module documentation for all crates 2023-08-28 23:09:37 +03:00
loader perf: cache the current language configuration to lookup later on 2023-09-21 00:52:50 -04:00
npm feat: improve dsl definitions 2023-08-16 02:24:33 -04:00
src Fix formatting 2023-10-25 10:24:35 +03:00
vendor Add a highlight subcommand 2019-02-19 12:32:03 -08:00
build.rs cli: Fix build.rs in case of the current branch ref was packed 2023-01-03 00:44:01 +02:00
Cargo.toml chore(rust): improve perf for position funcs 2023-10-05 17:24:01 +03:00
emscripten-version emscripten: 3.1.37 2023-05-15 13:11:55 +03: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.