tree-sitter-cli
| Crates.io | tree-sitter-cli |
| lib.rs | tree-sitter-cli |
| version | 0.24.4 |
| source | src |
| created_at | 2019-02-05 20:25:55.76052 |
| updated_at | 2024-11-10 04:27:07.515086 |
| description | CLI tool for developing, testing, and using Tree-sitter parsers |
| homepage | https://tree-sitter.github.io/tree-sitter |
| repository | https://github.com/tree-sitter/tree-sitter |
| max_upload_size | |
| id | 112971 |
| size | 798,980 |
Amaan Qureshi (amaanq)
documentation
README
Tree-sitter CLI
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
nodeon your PATH. - To run and test parsers, you must have a C and C++ compiler on your system.
Commands
-
generate- Thetree-sitter generatecommand will generate a Tree-sitter parser based on the grammar in the current working directory. See the documentation for more information. -
test- Thetree-sitter testcommand will run the unit tests for the Tree-sitter parser in the current working directory. See the documentation for more information. -
parse- Thetree-sitter parsecommand will parse a file (or list of files) using Tree-sitter parsers.