Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Kodik Blueprint

IDA-like project blueprint for Kodik (and VS Code / Cursor).

Turns a whole codebase into an expandable graph: folders → files → classes / functions / types, plus import edges — so you can read large projects without documentation.


Features

  • Auto-opens blueprint on extension start
  • Hierarchy: workspace → folder → file → symbol
  • Import edges between files (relative imports)
  • Parsers: TypeScript/JavaScript, Python, Go, Rust, Java/Kotlin, C#, C/C++, and more
  • Pan, zoom, expand/collapse, jump to symbol in editor
  • Side view Blueprint + full editor panel

Requirements

  • Kodik or VS Code / Cursor / any VS Code-compatible editor
  • Node.js 18+ (to build)
  • An opened folder workspace (not a single file)

Install (users)

Option A — VSIX from Releases

  1. Download kodik-blueprint-*.vsix from Releases.
  2. In Kodik / VS Code:
    • Ctrl+Shift+PExtensions: Install from VSIX…
    • pick the .vsix file
  3. Open any project folder.
  4. Run Blueprint: Open Project Graph
    or click the Blueprint icon on the activity bar.

Option B — from source

git clone https://github.com/DaxRay/BluepribtCodeKodik
cd kodik-blueprint
npm install
npm run compile

Then run with Extension Host (see below).


Run with Kodik (recommended)

Kodik is based on VS Code and accepts the same --extensionDevelopmentPath flag.

# 1) Build the extension
cd /path/to/kodik-blueprint
npm install
npm run compile

# 2) Download Kodik for Linux (AppImage), if you don't have it yet
#    https://aikodik.ru/download
#    or:
# curl -L -o ~/Apps/Kodik-2.1.0.AppImage \
#   https://kodik.s3.ru-3.storage.selcloud.ru/releases/linux/2.1.0/Kodik-2.1.0.AppImage
# chmod +x ~/Apps/Kodik-2.1.0.AppImage

# 3) Launch Kodik with this extension loaded + any project to visualize
~/Apps/Kodik-2.1.0.AppImage \
  --extensionDevelopmentPath="$PWD" \
  /path/to/project-you-want-to-explore

Inside Kodik:

  1. Wait for the blueprint panel (auto-open is on by default), or
  2. Ctrl+Shift+PBlueprint: Open Project Graph

VS Code / Cursor fallback

code --extensionDevelopmentPath="$PWD" /path/to/project
# or
cursor --extensionDevelopmentPath="$PWD" /path/to/project

From the IDE (F5)

  1. Open the kodik-blueprint folder in Kodik / VS Code
  2. Press F5Run Extension
  3. In the new window, open the repo you want to blueprint

Graph controls

Action How
Pan Drag empty canvas
Zoom Mouse wheel
Select node Click
Expand / collapse Double-click
Open in editor Inspector → Open
Depth Depth slider (1–5)
Import wires Imports checkbox
Rescan Refresh or command Blueprint: Refresh Graph

Commands

Command Description
Blueprint: Open Project Graph Open full blueprint panel
Blueprint: Refresh Graph Rescan workspace

Settings

Setting Default Description
kodikBlueprint.autoOpenOnStartup true Open graph on activate
kodikBlueprint.maxFiles 800 Max files to analyze
kodikBlueprint.exclude node_modules, dist, … Glob excludes
{
  "kodikBlueprint.autoOpenOnStartup": true,
  "kodikBlueprint.maxFiles": 1500,
  "kodikBlueprint.exclude": [
    "**/node_modules/**",
    "**/dist/**",
    "**/out/**",
    "**/.git/**",
    "**/vendor/**",
    "**/build/**"
  ]
}

Publish to GitHub

1. Build & package

git clone https://github.com/<YOUR_USER>/kodik-blueprint.git
cd kodik-blueprint
npm install
npm run compile
npx @vscode/vsce package --no-dependencies
# → kodik-blueprint-0.1.0.vsix

2. Push the repo

git add .
git commit -m "Initial release: Kodik Blueprint graph viewer"
git branch -M main
git remote add origin https://github.com/<YOUR_USER>/kodik-blueprint.git
git push -u origin main

3. Attach VSIX to a Release

gh release create v0.1.0 kodik-blueprint-0.1.0.vsix \
  --title "v0.1.0" \
  --notes "First public blueprint viewer for Kodik / VS Code."

What not to commit

Already in .gitignore:

  • node_modules/
  • out/ (build from source; do not push unless you want prebuilt JS)
  • *.vsix
  • *.log

Optional CI

.github/workflows/ci.yml:

name: CI
on:
  push:
    branches: [main]
  pull_request:
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: "20"
      - run: npm ci
      - run: npm run compile

Repository layout

kodik-blueprint/
├── media/            # canvas UI (CSS/JS)
├── src/
│   ├── extension.ts  # activation + commands
│   ├── analyzer/     # project scanner + language parsers
│   └── webview/      # HTML + WebviewViewProvider
├── out/              # tsc output (after npm run compile)
├── package.json      # extension manifest
├── tsconfig.json
└── README.md

Compatibility

Host Status
Kodik Target (VS Code Extension API)
VS Code Yes
Cursor Yes
Open VSX / Marketplace Publish separately via vsce / ovsx

Troubleshooting

Empty graph — open a folder (File → Open Folder), not a single file.

truncated in stats — raise kodikBlueprint.maxFiles or tighten exclude.

No import edges — only relative imports (./, ../) are resolved for now.

Extension not loading in Kodik — reinstall VSIX, then Developer: Reload Window.

F5 does nothing — need .vscode/launch.json (included) and compiled out/.

AppImage won't startchmod +x Kodik-*.AppImage; on some distros install libfuse2.


Roadmap

  • Call-graph edges (not only imports)
  • Tree-sitter parsers
  • Symbol search / filter
  • Persist layout & bookmarks
  • Auto package clustering

License

MIT

Author

Built for Kodik IDE — blueprint reading of large codebases without docs.

About

Расширение для kodik IDE, для удобного анализрования кода

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages