⣀⣠⣤⣤⣀⣀ ⢠⣶⠟⠛⠉⠉⠉⠛⠻⢿⣶⣤⡀ ⢠⡿⠁ ⣍⠻⢿⣦⡀ ⢠⡿⠁ ⠈⢧⣄⠛⢿⣶⣄⣠⡾⣧⡀ ⢀⣿⠃ ⠘⣿⣷⣦⡉⠻⣫⣾⡽⣷ ⣿⠇ ⣀⣀⡀ ⣀⣀⡀ ⠸⣿⠻⣿⣾⡿⠃ ⠹⣿⣷⡀ ⣸⣿⠟⠛⠉ ⠉⠛⠻⣿⣇ ⠈⠛⠛⠒ ⢠⣿⠃ ⢀⣀⣠⣤⣤⣤⣤⣤⣤⣤⣤⣤⣤⣀⡀ ⠘⣿⡆

Installation

npm

Install the CLI globally:

$ npm install -g orstrum

Verify

$ orstrum --version
0.x.x

Requirements

Node.js 20+
A TypeScript, JavaScript, or Python project. A tsconfig.json (or jsconfig.json) is optional — it's only consulted for path-alias resolution; scanning works without one.

Orstrum bundles its own parsers — ts-morph for TypeScript/JavaScript and a tree-sitter WASM grammar for Python. No separate TypeScript or Python toolchain installation is required.