# Setup script for karakeep-app/karakeep on Windows (PowerShell), from https://gitmanual.com/karakeep-app/karakeep # Read it before you run it: the commands come from the repo's own README and files. # Run: powershell -ExecutionPolicy Bypass -File .\setup.ps1 $ErrorActionPreference = "Stop" function Write-Step($t) { Write-Host "`n==> $t" -ForegroundColor Cyan } # Windows ships a python that only opens the Microsoft Store; it doesn't count. function Have($c) { $cmd = Get-Command $c -ErrorAction SilentlyContinue; [bool]$cmd -and $cmd.Source -notlike '*\WindowsApps\*' } # New installs change PATH; pick it up without opening a new window. function Update-Path { $env:Path = [Environment]::GetEnvironmentVariable("Path", "Machine") + ";" + [Environment]::GetEnvironmentVariable("Path", "User") } # Stop when a program fails, like bash's set -e. Dot-sourced, so cd and venv activation carry on to the next step. function Invoke-Step([scriptblock]$Block) { $global:LASTEXITCODE = 0; . $Block; if ($LASTEXITCODE) { throw "Failed with exit code $LASTEXITCODE" } } Write-Step '1/4 Clone the repository' if (-not (Test-Path 'karakeep')) { Invoke-Step { git clone https://github.com/karakeep-app/karakeep.git } } Set-Location 'karakeep' Write-Step '2/4 Install the required runtimes' # Node.js 24 if (-not (Have 'nvm') -and -not (Have 'node')) { Invoke-Step { winget install CoreyButler.NVMforWindows -e --accept-source-agreements --accept-package-agreements }; Update-Path } if (Have 'nvm') { Invoke-Step { nvm install 24 } } elseif (Have 'node') { Write-Host "nvm not found: using Node $(node -v)" } else { throw 'Needs Node.js: install nvm-windows or Node.js' } if (Have 'nvm') { Invoke-Step { nvm use 24 } } elseif (Have 'node') { Write-Host "nvm not found: using Node $(node -v)" } else { throw 'Needs Node.js: install nvm-windows or Node.js' } Write-Step '3/4 Configure environment variables' # Fill in secrets: MEILI_MASTER_KEY, NEXTAUTH_SECRET, KARAKEEP_API_KEY, OPENAI_API_KEY if (-not (Test-Path .env)) { Copy-Item .env.sample .env; Write-Host 'Created .env. Fill in secrets: MEILI_MASTER_KEY, NEXTAUTH_SECRET, KARAKEEP_API_KEY, OPENAI_API_KEY in .env, then run this script again.'; exit 0 } Write-Step '4/4 Install dependencies' Invoke-Step { corepack enable } Invoke-Step { pnpm install } Write-Host 'Set up karakeep-app/karakeep.' Write-Host 'Fill in secrets: MEILI_MASTER_KEY, NEXTAUTH_SECRET, KARAKEEP_API_KEY, OPENAI_API_KEY' Write-Host 'Next, from the project folder:' Write-Host ' pnpm dev' Write-Host ' pnpm test' Write-Host 'Manual: https://gitmanual.com/karakeep-app/karakeep'