Documentation menu

Start

Installation

Choose a local, one-off, or CI installation method. No hidden global state, no background processes.

Project dependency (recommended)

Pin the CLI in your repository so every team member and CI run uses the same version. This is the recommended approach for teams.

TERMINAL
pnpm add -D @0xsarwagya/ontoly-cli@rc
pnpm exec ontoly --version

One-off execution

Use pnpm dlx to evaluate Ontoly without modifying your package.json. Good for trying it on a new repository.

TERMINAL
pnpm dlx @0xsarwagya/ontoly-cli@rc build .

Global installation

Install globally when you want ontoly available across all projects. Useful for personal machines, but CI should always pin a project-local version.

TERMINAL
pnpm add -g @0xsarwagya/ontoly-cli@rc
ontoly --version

Requirements

Ontoly runs on any system with a supported Node.js release. Git is required for history-based intelligence (ownership, churn, hotspots).

  • Node.js 20 or 22 (LTS releases)
  • pnpm, npm, or yarn as package manager
  • Git for history and ownership artifacts
  • A TypeScript or JavaScript project
  • Read access to repository source files