Skip to main content

Quickstart

Get Lore running locally in under five minutes.

1. Install the CLI​

npm install -g @lore/cli

2. Authenticate​

lore login

This opens your browser to sign in with your Lore account. After authenticating, you'll be prompted to select a workspace if you belong to more than one. Credentials are stored in ~/.lore/config.json.

You can also pass a custom server URL if you're running Lore locally:

lore login --url http://localhost:3001

3. Capture knowledge​

Send a text snippet directly from your terminal:

lore capture "Redis failover: switch to replica-2, then promote via redis-cli"

You can also pipe content in:

pbpaste | lore capture
echo "Deploy note: always run migrations before restarting workers" | lore capture

4. Check your workspace​

lore workspace show

This displays your active workspace name, slug, and role.

What's next​