0fdf569571
* Move all rust crates (except lib) into crates dir, w/o nesting * Remove stale path from .gitattributes * Rename lib.rs files for easier navigation * Rename mod.rs file for easier navigation * Fix emscripten-version path * Fix fixtures dir paths * Use the default rustfmt settings * Don't use nightly on CI
44 lines
1.7 KiB
Markdown
44 lines
1.7 KiB
Markdown
# Tree-sitter CLI
|
|
|
|
[![crates.io badge]][crates.io] [![npmjs.com badge]][npmjs.com]
|
|
|
|
[crates.io]: https://crates.io/crates/tree-sitter-cli
|
|
[crates.io badge]: https://img.shields.io/crates/v/tree-sitter-cli.svg?color=%23B48723
|
|
[npmjs.com]: https://www.npmjs.org/package/tree-sitter-cli
|
|
[npmjs.com badge]: https://img.shields.io/npm/v/tree-sitter-cli.svg?color=%23BF4A4A
|
|
|
|
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`:
|
|
|
|
```sh
|
|
cargo install --locked tree-sitter-cli
|
|
```
|
|
|
|
or with `npm`:
|
|
|
|
```sh
|
|
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`](https://nodejs.org) 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.
|
|
|
|
[the documentation]: https://tree-sitter.github.io/tree-sitter/creating-parsers
|
|
[the releases page]: https://github.com/tree-sitter/tree-sitter/releases/latest
|