traxys/tree-sitter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
tree-sitter/cli
History
Scorg 40eb26e580 build(bindings): move header to tree_sitter subdirectory 
This patch allows users to include the parser by the same path from
local build as well as installed location. Previously it was not
possible to include the header prior to installing the built parser.
2025-01-20 13:17:24 -05:00
..
benches feat: add fuzz subcommand 2024-05-30 23:00:45 -04:00
config fix(cli): use xdg config directory on macOS 2024-12-23 02:09:06 -05: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(cli): improve error message for nonterminals used in token rule 2025-01-13 01:12:20 -05:00
loader fix(wasm): check docker presence without arguments 2025-01-08 13:27:02 -05:00
npm feat: support passing in a Rust regex in the grammar dsl 2025-01-06 20:52:19 -05:00
src build(bindings): move header to tree_sitter subdirectory 2025-01-20 13:17:24 -05:00
vendor Add a highlight subcommand 2019-02-19 12:32:03 -08:00
build.rs docs: move assets to correct path 2024-12-25 21:23:36 -05:00
Cargo.toml fix(cli): use xdg config directory on macOS 2024-12-23 02:09:06 -05:00
README.md docs(rust): add --locked to installation instructions 2024-10-30 10:51:46 -04:00

README.md

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.