Skip to content

setup.md

Latest commit

 

History

History
79 lines (58 loc) · 1.21 KB

setup.md

File metadata and controls

79 lines (58 loc) · 1.21 KB
Raw

Local Development Setup

Prerequisites

  • Node.js 20+
  • pnpm (npm install -g pnpm)
  • AWS credentials configured (for Bedrock) or an Anthropic API key or Ollama installed locally

Install

git clone <repo>
cd lorecraft
pnpm install

Environment

Copy .env.example to .env and fill in your provider credentials:

cp .env.example .env

Amazon Bedrock (default)

LLM_PROVIDER=bedrock
AWS_REGION=us-east-1
AWS_PROFILE=default

Anthropic direct

LLM_PROVIDER=anthropic
ANTHROPIC_API_KEY=sk-ant-...

Ollama (local, no account required)

LLM_PROVIDER=ollama
OLLAMA_BASE_URL=http://localhost:11434
OLLAMA_MODEL=llama3

Run the CLI

pnpm cli

Point Lorecraft at your vault when prompted, or set:

VAULT_ROOT=/path/to/your/obsidian/vault

Run tests

pnpm test           # run all tests once
pnpm test:watch     # watch mode
pnpm test:coverage  # with coverage report

Type check

pnpm typecheck

Always run before committing. CI will fail on type errors.

Web UI (v0.4+)

pnpm dev    # starts Next.js on http://localhost:3000

Not functional until v0.4. The app/ directory is scaffolded but empty.