Skip to content
Lifebase Docs
Pricing
English

Install Lifebase

Use the official CLI for a new installation. If you already have Lifebase files, follow Connect an existing vault instead.

Check your environment

Section titled “Check your environment”

In a terminal, check that Node.js is version 20 or newer and npm is available:

Terminal window
node --version
npm --version

Install Node.js and Obsidian if they are missing. The CLI itself does not require Python or a compiler. Individual agent workflows may need additional tools; onboarding checks the environment needed for your selected workflows.

On Linux, authentication requires secret-tool and an unlocked Secret Service-compatible keyring. On macOS the CLI uses Keychain; on Windows it uses current-user DPAPI protection.

Run the installer

Section titled “Run the installer”
Terminal window
npm install -g @lifebase/cli
lifebase

The wizard guides you through these steps:

  1. In Sign in, choose Lifebase account to approve Google/GitHub sign-in in a browser and select a linked license, or License key to enter a key in the hidden prompt. Do not paste a key into an AI conversation.
  2. Choose a new or empty writable installation folder. The recommended location is a lifebase folder in Documents.
  3. Select the content language and a release included in your license.
  4. Read and accept the license terms.
  5. Let the CLI download and verify the release, then choose which detected AI agents to configure.

Use the arrow keys to move and Enter to select. Esc returns from a nested prompt. Agent setup connects an already installed tool to your vault; it does not install the agent or sign in to a model provider.

Install English content directly

Section titled “Install English content directly”

The wizard is the easiest way to choose a language. For a direct command on macOS or Linux:

Terminal window
lifebase install --path ~/Documents/lifebase --locale en

On Windows, pass your actual absolute destination, for example:

Terminal window
lifebase install --path "C:\Users\YourName\Documents\lifebase" --locale en

Replace YourName with your Windows user folder. A direct new installation defaults to Korean when --locale is omitted. English content must be available in the release catalog for this command to succeed. Use lifebase releases to inspect availability.

Open the installed folder

Section titled “Open the installed folder”

In Obsidian, choose Open folder as vault and select the installed lifebase folder. Enable the bundled community plugins when prompted. Keep the whole folder together, including its hidden settings and version metadata.

Open the same folder as your agent’s working project and continue with Your first session. If installation fails, retain the error text and use Troubleshooting; do not reinstall over your personal notes to try to fix it.