Source
Open a folder to download the code on Windows Explorer
Press Ctrl+L , run
powershell and execute:irm https://brokensrc.dev/get.ps1 | iex
irm downloads the script, iex executes it directly Don't want to use it? Follow the Manual tab above!
Open a Terminal on some directory and run:
/bin/bash -c "$(curl -sS https://brokensrc.dev/get.sh)"
curl downloads the script, bash executes it directly Don't want to use it? Follow the Manual tab above!
Open a Terminal on some directory and run:
/bin/bash -c "$(curl -sS https://brokensrc.dev/get.sh)"
curl downloads the script, bash executes it directly Don't want to use it? Follow the Manual tab above!
Download the code
git clone https://github.com/BrokenSource/BrokenSource --recurse-submodules
Enter the directory
cd BrokenSource
Ensure submodules are on main
git submodule foreach --recursive 'git checkout main || true'
Create venv and install dependencies
uv sync --all-packages
Start using any Project
uv run shaderflow
uv run depthflow
uv run broken
Activate the venv
# Windows:
.venv\Scripts\Activate.ps1 # PowerShell
.venv\Scripts\Activate.bat # CMD
# Linux and MacOS:
source .venv/bin/activate # Bash
source .venv/bin/activate.fish # Fish
Start using any Project
broken
shaderflow
depthflow
♻️ Uninstalling¶
Apart from deleting the BrokenSource folder where you cloned the code,
Workspaces: Where data, models, versions, cache of the projects are stored
All project's Workspaces are located in your platform's User Data directory:
| Windows | C:\Users\(...)\AppData\Local\BrokenSource |
| MacOS | ~/Library/Application Support/BrokenSource |
| Linux | ~/.local/share/BrokenSource |
Models: PyTorch, HuggingFace, TorchHub downloads models on:
| Windows | C:\Users\(...)\.cache\{huggingface,transformers,torch} |
| MacOS | ~/Library/Caches/{huggingface,transformers,torch} |
| Linux | ~/.cache/{huggingface,transformers,torch} |
Package manager cache:
Either run uv cache prune or uv cache dir to locate wheel downloads caches, should be at:
| Windows | C:\Users\(...)\AppData\Local\uv |
| MacOS | ~/Library/Caches/uv |
| Linux | ~/.cache/uv |
Either run pip cache purge or pip cache dir to locate wheel download caches, should be at:
| Windows | C:\Users\(...)\AppData\Local\pip |
| MacOS | ~/Library/Caches/pip |
| Linux | ~/.cache/pip |
Either run poetry cache clear or poetry cache list to locate caches and venvs, should be at:
| Windows | C:\Users\(...)\AppData\Local\pypoetry |
| MacOS | ~/Library/Caches/pypoetry |
| Linux | ~/.cache/pypoetry |
Either run pdm cache clear or pdm cache list to locate wheel downloads caches, should be at:
| Windows | C:\Users\(...)\AppData\Local\pdm |
| MacOS | ~/Library/Caches/pdm |
| Linux | ~/.cache/pdm |