traxys/tree-sitter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
tree-sitter/cli
History
Max Brunsfeld b1ad55909d 0.20.8
2023-03-13 12:22:10 -07:00
..
benches cli: Extract CLI configuration into separate crate 2021-06-10 10:21:22 -04:00
config cli: Stop config.json search sooner if TREE_SITTER_DIR set 2023-01-16 15:30:40 +09:00
loader loader: use portable way of path joining 2023-01-11 04:12:13 +02:00
npm 0.20.8 2023-03-13 12:22:10 -07:00
src Add unit test for querying within a range of a long top-level repetition 2023-02-16 12:03:51 -08: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 0.20.8 2023-03-13 12:22:10 -07:00
emscripten-version Bump Emscripten version to 3.1.29 2023-01-06 08:32:31 +02:00
README.md chore(docs): Fix misprints 2021-09-22 00:24:36 +03:00

README.md

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 files) using Tree-sitter parsers.