Skip to content

Commit 0e96010

Browse files
authored
docs(readme): document tree-sitter CLI prereq and recommend mise (#36)
The Prerequisites section listed only "Node.js >= 20 and pnpm >= 8", missing the tree-sitter CLI requirement that `pnpm build` needs to generate the parser in `packages/parser-tree-sitter`. New contributors hit "sh: tree-sitter: command not found" with no guidance from the README. Recommends `mise install` as the primary setup path (respects the pinned 0.25.x line in mise.toml) and provides a manual-install fallback that explicitly lists Node 22, pnpm 10, and the tree-sitter CLI 0.25.x. Calls out the macOS Homebrew gotcha: `brew install tree-sitter` ships only the C library; the CLI is a separate `tree-sitter-cli` formula (which currently ships 0.26.x, a minor mismatch with the pin). Addresses #33 Part B (the undocumented CLI prerequisite). Part A (Node 26 compatibility) is covered by #23 and #27. Refs #33
1 parent 4670b96 commit 0e96010

1 file changed

Lines changed: 13 additions & 1 deletion

File tree

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,19 @@ In this sense Agent Script follows the same pattern as other industry-standard d
3838

3939
### Prerequisites
4040

41-
Node.js >= 20 and pnpm >= 8
41+
The simplest setup is to use [mise](https://mise.jdx.dev/), which installs the toolchain versions pinned in [`mise.toml`](mise.toml) (Node.js and the `tree-sitter` CLI):
42+
43+
```bash
44+
mise install
45+
```
46+
47+
To set up manually instead:
48+
49+
- **Node.js 22** (minimum `>=18`)
50+
- **pnpm 10** — run `corepack enable pnpm` once; pnpm will resolve to the version pinned by `packageManager` in `package.json`
51+
- **`tree-sitter` CLI 0.25.x** on your `$PATH` — required by `pnpm build` to generate the parser for `packages/parser-tree-sitter`. Install via `mise install`, or download a 0.25.x binary from [tree-sitter releases](https://github.com/tree-sitter/tree-sitter/releases).
52+
53+
**macOS note:** `brew install tree-sitter` installs only the C library, not the CLI. For the CLI on macOS, use `mise install` (recommended; matches the pinned 0.25.x line) or `brew install tree-sitter-cli` (currently ships 0.26.x).
4254

4355
### Installation
4456

0 commit comments

Comments
 (0)