Skip to Content
Getting StartedInstall

Install

codespine is published to npm as codespine. Every command in these docs runs through npx, so there is no global install to manage — you point the binary at any TypeScript project and go.

Run it in your Coding Agent

Install the bundled Claude Code  assets — the /codespine-optimize and /codespine-interview slash commands and the codespine-query skill — into your project’s .claude/ so the agent can drive the graph:

npx codespine install

There is no API key or LLM provider to configure: the agent runtime is Claude Code itself. See install for options and Agent slash commands for what each command does.

Prerequisites

  • Node.js ≥ 20.12 (check with node --version).
  • The target project must have a tsconfig.json — the extractor loads it through ts-morph from that config.
  • For the optimization agent only: Claude Code . The agent ships as the /codespine-optimize slash command, so there is no API key or LLM provider to configure — the agent runtime is Claude Code itself.

Run it on your own project

No install step. From the root of any project with a tsconfig.json:

npx codespine extract . --semantic npx codespine load npx codespine dead-exports

npx fetches the published binary on first use and caches it. See The pipeline for the full walk-through.

Clone the repository

To try the tool on its own source, or to add your own traversal, clone the repo and install its dependencies:

git clone https://github.com/jeromeetienne/codespine.git cd codespine npm install

From a checkout you can run the CLI through the bundled npm scripts (npm run extract -- . --semantic, npm run dev -- load, …) or, as the docs do, with npx codespine <command>.

Next

Walk the end-to-end pipeline — extract a graph, load it, query it, and run the optimization agent on its first verified edit — in The pipeline.

Last updated on