Install and Run

Install options

Option 1: Download a desktop app (no Node required)

Current published installer links are available for Windows and Linux.

Platform	Package	Download
Windows	NSIS installer	KeyperSetup.v1.1.1.exe
Linux	AppImage	Keyper-1.1.1.AppImage
Linux (Debian/Ubuntu)	.deb (x86_64)	keyper_1.1.1_amd64.deb
Linux (Debian/Ubuntu)	.deb (ARM64)	keyper_1.1.1_arm64.deb

Windows quick start:

1. Download KeyperSetup.v1.1.1.exe.
2. Run the installer and follow the setup wizard.
3. Launch Keyper from the Start menu or desktop shortcut.

Linux AppImage quick start:

chmod +x Keyper-1.1.1.AppImage
./Keyper-1.1.1.AppImage

Linux .deb quick start:

sudo dpkg -i keyper_1.1.1_amd64.deb
keyper   # or launch from your applications menu

Option 2: Docker (no Node required)

Prerequisites: Docker + Docker Compose.

git clone https://github.com/pinkpixel-dev/keyper.git
cd keyper

# Build and start on http://localhost:8080
docker compose up -d

# Custom port
HOST_PORT=3030 docker compose up -d

The container exposes the compiled SPA on port 80 internally. No volumes or environment variables are needed — all configuration (Supabase credentials or SQLite provider selection) is entered in-app and stored in browser localStorage.

Option 3: Global npm install

Prerequisites: Node.js 18+.

npm install -g @pinkpixel/keyper
keyper

Option 4: NPX (no install)

npx @pinkpixel/keyper

Option 5: Local repo / development

git clone https://github.com/pinkpixel-dev/keyper.git
cd keyper
npm install
npm run dev      # Vite dev server
# or
npm run build && npm start   # production preview

Option 6: Build Electron installers from source

git clone https://github.com/pinkpixel-dev/keyper.git
cd keyper
npm install

npm run electron:build:linux   # AppImage + deb
npm run electron:build:win     # NSIS installer

First run

1. Open the app URL (default http://localhost:4173 for npm/npx, http://localhost:8080 for Docker, or the Electron window).
2. In the setup wizard, choose your database provider:
   • SQLite (Local) — zero-config, no account required; schema is created automatically. In browser/PWA mode it persists locally in IndexedDB. In Electron it can also target a file on disk.
   • Supabase — enter your Supabase URL and anon/publishable key, then run the SQL setup script to create required tables/policies. Existing users should also run migration-add-document-misc-types.sql to enable document and misc credential types.
3. Return to the app, test connection, and save.
4. Unlock or initialize your vault using your master passphrase.
5. For additional users, choose Create New User on the lock screen or use Dashboard Settings → User Management → Add New User.
6. To switch accounts later, use Dashboard Settings → User Management and then unlock with that user’s passphrase.

Verify health

npm run test:run
npm run build

Both commands currently pass on the audited codebase.