Skip to content

Commit 269a711

Browse files
committed
docs: document pip/Homebrew install of the cants command
The main and PyPI READMEs only showed building from source via Bun; add an Install section covering 'pip install codeanalyzer-typescript' (and Homebrew), which is the headline of v0.2.1 — the wheel now ships a cants launcher on PATH.
1 parent a7d0d9f commit 269a711

2 files changed

Lines changed: 32 additions & 6 deletions

File tree

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,40 @@ It is the TypeScript backend behind [CLDK](https://github.com/codellm-devkit/pyt
99
mirroring its [Python](https://github.com/codellm-devkit/codeanalyzer-python) and
1010
[Java](https://github.com/codellm-devkit/codeanalyzer-java) siblings.
1111

12-
## Prerequisites
13-
14-
- [Bun](https://bun.sh/) 1.0 or higher (used to run and compile the analyzer)
15-
1612
The analyzer resolves types and call targets with the TypeScript compiler, so the project
1713
being analyzed should be a normal Node/TypeScript project. By default, the analyzer
1814
materializes the project's dependencies (`node_modules`) so that imported library calls can
1915
be resolved as phantom (external) nodes; pass `--no-build` to reuse an already-prepared
2016
`node_modules`.
2117

22-
### Install Bun
18+
## Install
19+
20+
The quickest way to get the `cants` command is from PyPI — the wheel bundles a prebuilt,
21+
self-contained binary for your platform (no Bun or Node required to run it):
2322

2423
```bash
25-
curl -fsSL https://bun.sh/install | bash
24+
pip install codeanalyzer-typescript
25+
cants --help
2626
```
2727

28+
This is also the package CLDK's Python SDK depends on to locate the analyzer backend.
29+
30+
Alternatively, install it with [Homebrew](https://brew.sh/):
31+
32+
```bash
33+
brew install codellm-devkit/homebrew-tap/codeanalyzer-typescript
34+
```
35+
36+
To build from source instead, see [Building `cants`](#building-cants) below.
37+
2838
## Building `cants`
2939

40+
Building from source requires [Bun](https://bun.sh/) 1.0 or higher:
41+
42+
```bash
43+
curl -fsSL https://bun.sh/install | bash
44+
```
45+
3046
Clone the repository and install dependencies:
3147

3248
```bash

packaging/python/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,16 @@ It is the TypeScript backend behind [CLDK](https://github.com/codellm-devkit/pyt
99
mirroring its [Python](https://github.com/codellm-devkit/codeanalyzer-python) and
1010
[Java](https://github.com/codellm-devkit/codeanalyzer-java) siblings.
1111

12+
## Install
13+
14+
```bash
15+
pip install codeanalyzer-typescript
16+
```
17+
18+
The wheel bundles a prebuilt, self-contained `cants` binary for your platform (no Bun or
19+
Node required to run it) and installs a `cants` command on your `PATH`. CLDK's Python SDK
20+
depends on this package to locate the analyzer backend.
21+
1222
## Usage
1323

1424
The analyzer provides a command-line interface for performing static analysis on

0 commit comments

Comments
 (0)