Skip to content
// quickstart [ 0.01 ]

Quickstart

Get Elith running in under 5 minutes.


Quickstart

Get Elith running in under 5 minutes.

// Install

Choose your preferred method:

curl
curl -fsSL https://elith.silohq.tech/install.sh | sh
npm
bashcopy
npm install -g @elith/cli
pnpm
bashcopy
pnpm add -g @elith/cli
bun
bun add -g @elith/cli
brew
brew install elith

// Configure Provider

On first run, Elith will guide you through setup:

elith

You'll see an interactive wizard:

// flow
_____ _ _ _ _
| ____| (_) |_| |__
| _| | | | __| '_ \
| |___| | | |_| | | |
|_____|_|_|\__|_| |_|
Elith Configuration Wizard
Let's set up your AI providers
Available providers:
→ Claude (Anthropic)
Cloud-based, most capable
LM Studio (Local)
Run models locally, privacy-focused
OpenRouter (Multiple models)
Access to multiple providers
Use ↑/↓ arrow keys to navigate, Enter to select

After selecting a provider, enter your API key (or endpoint for local models):

Claude (Anthropic) Configuration
Enter your Anthropic API key: sk-ant-...
Model name [claude-sonnet-4-20250514]: 

✓ Configuration complete!
Starting Elith...

The backend will auto-start on http://localhost:8000.

// Run Your First Operation

Explain Your Codebase

bashcopy
elith explain

Output:

[cyan]Scanning repository: /path/to/your/project[/cyan]
[green]✓ Found 47 files[/green]

[Elith Skill: list_files({"path": ".", "recursive": true})]
→ Contents of .:
📁 src
📁 tests
📄 package.json
...

[cyan]Thinking...[/cyan]

This is a Node.js application with the following structure:

**Overall Architecture:**
The project follows a standard MVC pattern with...

**Key Components:**
1. src/auth/ - Authentication module handling...
2. src/api/ - REST API endpoints...
...

Refactor Code

bashcopy
elith refactor src/cache/redis-client.ts --focus "modernize to redis v4"

Generate Tests

bashcopy
elith test-gen src/auth/login.ts

Design Architecture

bashcopy
elith architect --problem "Add rate limiting to API endpoints"

// What Just Happened?

  1. Context Engine scanned your repo and selected relevant files
  2. Provider (Claude/LM Studio/OpenRouter) received the context
  3. Skills were called automatically via tool calling
  4. Output streamed in real-time
  5. Session logged to bob-reports/session_TIMESTAMP.md

// Check the Backend

The backend auto-started. Check its status:

bashcopy
elith service status

Output:

✓ Backend is running
  Port: 8000
  PID: 12345
  Logs: ~/.elith/backend.log

// View Session History

All operations are logged:

bashcopy
ls bob-reports/

Output:

session_20260517_153549_f27343a8.md
session_20260517_155715_2be4178f.md
session_history.json

// Service Management

# Start backend manually
elith service start

# Stop backend
elith service stop

# Restart backend
elith service restart

# View logs
tail -f ~/.elith/backend.log

// Reconfigure Provider

To change providers or update API keys:

bashcopy
elith init

// Next Steps