traxys/tree-sitter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
tree-sitter/cli
History
Nickolay 6895b7a1e1
Add some documentation to the playground page 
The minimal UI of the Playground could benefit from some documentation to make it easier for the newer users to understand what's going on. Also added a link to the new documentation from the local playground.

Closes https://github.com/tree-sitter/tree-sitter/issues/1305
2024-02-15 16:24:21 +01:00
..
benches feat: improve time reports 2024-02-07 03:19:02 -05:00
config build: move common Cargo.toml keys into the workspace and inherit them 2024-02-14 14:56:23 -05:00
loader chore: deprecate C++ scanners 2024-02-14 15:43:53 -05:00
npm fix(cli): installation via a HTTP tunnel proxy 2024-02-11 03:58:14 -05:00
src Add some documentation to the playground page 2024-02-15 16:24:21 +01:00
vendor Add a highlight subcommand 2019-02-19 12:32:03 -08:00
build.rs chore(cli): apply clippy fixes 2024-02-04 04:18:48 -05:00
Cargo.toml build: move common Cargo.toml keys into the workspace and inherit them 2024-02-14 14:56:23 -05:00
README.md docs: update badges; fix markdown lint complains 2023-04-16 23:39:08 +03: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 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.