Download EN · FR Log in

IDE Integration

Legacy v1.2 reference: this page is kept for compatibility. For current Studio installation, use the download page.

Use BranchPy CLI from your IDE when you want fast iteration without leaving your editor.

VS Code tasks (without extension)

Create .vscode/tasks.json:

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "BranchPy Analyze",
      "type": "shell",
      "command": ".venv\\Scripts\\python.exe",
      "args": [
        "-m",
        "branchpy",
        "--project",
        "${workspaceFolder}",
        "analyze",
        "--open"
      ],
      "group": "build",
      "problemMatcher": []
    },
    {
      "label": "BranchPy Stats",
      "type": "shell",
      "command": ".venv\\Scripts\\python.exe",
      "args": [
        "-m",
        "branchpy",
        "--project",
        "${workspaceFolder}",
        "stats",
        "--open"
      ],
      "problemMatcher": []
    }
  ]
}

JetBrains External Tool

Suggested command:

Program: python
Arguments: -m branchpy --project $ProjectFileDir$ analyze --open
Working directory: $ProjectFileDir$

Cursor/Windsurf or terminal-first IDEs

Run directly in an integrated terminal:

branchpy --project . analyze --open
branchpy --project . stats --open

Best practice

Prefer environment-qualified execution in local dev:

.venv\Scripts\python.exe -m branchpy --project . analyze --open

This avoids older user-site installs shadowing your active environment.