tree-sitter/cli
Andrew Hlynskyi 613382c70a docs: update badges; fix markdown lint complains
Linter config `.vscode/settings.json`:
```json
{
    "[markdown]": {
        "files.trimTrailingWhitespace": false,
    },
    "markdownlint.config": {
        "default": true,
        // "ul-style": {
        //     "style": "asterisk"
        // },
        "MD001": false,
        "MD024": false,
        "MD025": false,
        "MD033": false,
        "MD041": false,
        "MD053": false,
    },
}
```
2023-04-16 23:39:08 +03:00
..
benches cli: Extract CLI configuration into separate crate 2021-06-10 10:21:22 -04:00
config cargo: specify minimum supported Rust version 2023-04-04 03:42:55 +03:00
loader cargo: specify minimum supported Rust version 2023-04-04 03:42:55 +03:00
npm fix(dsl): fix formatting 2023-04-09 19:53:36 +03:00
src fix: Use / paths when building WASM 2023-04-07 13:07:45 -05: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 fix: Use / paths when building WASM 2023-04-07 13:07:45 -05:00
emscripten-version Bump Emscripten version to 3.1.29 2023-01-06 08:32:31 +02:00
README.md docs: update badges; fix markdown lint complains 2023-04-16 23:39:08 +03:00

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.