Skip to main content

Quickstart

This quickstart walks through the full Lore lifecycle: initialize, ingest, compile, retrieve, validate, and export.

1) Initialize​

lore init

Expected result: .lore/ is created with base config and storage layout.

2) Ingest content​

# local file
lore ingest ./README.md

# URL
lore ingest https://example.com/article

Expected result: new .lore/raw/<sha256>/ entries with extracted.md and meta.json.

3) Compile into wiki articles​

lore compile

Expected result: .lore/wiki/articles/*.md, updated .lore/wiki/index.md, refreshed search/link index.

4) Search and ask​

# lexical discovery
lore search "concept"

# graph + LLM answer
lore query "What is the architecture?"

5) Validate graph health​

lore lint --json

Use lint output to identify gaps, orphans, and ambiguous articles.

6) Export artifacts​

lore export bundle

Default output location: .lore/exports.

Optional: Continuous watch mode​

# auto-compile raw changes with debounce and queueing
lore watch

Optional: Repair-first indexing​

# useful after partial copies/interrupted operations
lore index --repair

End-to-End Script​

lore init
lore ingest ./README.md
lore ingest https://example.com/article
lore compile
lore index --repair
lore lint --json
lore query "What changed in architecture?"
lore export bundle

Quickstart Flow​

flowchart LR
	A[init] --> B[ingest]
	B --> C[compile]
	C --> D[index repair optional]
	D --> E[search/query]
	E --> F[lint]
	F --> G[export]

Next Steps​