Brainstash / installation

A home for your knowledge.

For Linux x64 glibc with Bun 1.4.2 installed. Follow the official Bun installation guide and confirm bun --version reports 1.4.2. The bundle includes the production API, web app and CLI; it runs on your machine.

1. Download Brainstash and its SHA-256 checksum. Verify with sha256sum -c brainstash-local-linux-x64.tar.gz.sha256, then unpack the archive into a new directory.
2. From the unpacked directory, start Brainstash with an absolute path to a separate directory for your notes and uploads:

   bun release/runtime.ts /absolute/path/to/brainstash-data

3. Open your Brainstash homepage and select Open your library, then Create one.

Keep your data directory when replacing the application bundle. Start with the same directory to reopen your library. Stop with Ctrl+C. Choose another loopback port with PORT if 4173 is in use.

The CLI is apps/cli/dist/brainstash. Create an API key in your library settings, then connect the CLI with apps/cli/dist/brainstash config set-url http://127.0.0.1:4173/api and apps/cli/dist/brainstash config set-key YOUR_API_KEY. File, shell and HTTP dynamic blocks require capabilities configured by the installation owner; account settings alone cannot grant machine access.