Installation

Installing the Package

Install effect-analyzer using your preferred package manager:

# npm
npm install effect-analyzer

# pnpm
pnpm add effect-analyzer

# yarn
yarn add effect-analyzer

ts-morph ships with the analyzer.

Effect v4 only

effect-analyzer supports Effect v4. It does not support Effect v3. Install a v4 release in the project you want to analyze:

npm install effect@^4.0.0

Global CLI Installation

If you want the effect-analyze command available globally, install with the -g flag:

npm install -g effect-analyzer

This lets you run effect-analyze from any directory without npx.

Verify Installation

Confirm everything is set up correctly:

npx effect-analyze --help
npx effect-analyze --version

You should see the CLI help output listing all available flags and formats, and the installed version.

TypeScript Configuration

The analyzer auto-detects your tsconfig.json for type information. If you need to point it at a specific config, use the --tsconfig flag:

npx effect-analyze ./src/program.ts --tsconfig ./tsconfig.app.json

Caution

If no tsconfig.json is found, the analyzer still works but type extraction (error types, service requirements) will be less accurate. For best results, ensure a tsconfig.json is present in your project root or specify one explicitly.

GitHub Action

To review every pull request without installing anything in the repository, add one workflow step. It posts a comment with the structural diff, railway diagrams, new lint findings and a merge-risk verdict for every Effect program the PR touched:

.github/workflows/effect-review.yml

name: Effect review
on:
  pull_request:
permissions:
  contents: read
  pull-requests: write
jobs:
  review:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 22
      - uses: jagreehal/effect-analyzer@v3
        with:
          path: src

See GitHub Action for every input, version pinning, monorepos and gating.

Next Steps

Head to the Quick Start to analyze your first Effect program, or the GitHub Action to put the review on every PR.