Getting Started

Getting Started

Get Loki Mode running in under 5 minutes.

---

Prerequisites

• Node.js 16+ or Homebrew (macOS/Linux)
• Claude Code CLI installed and authenticated
• A spec describing what to build -- a PRD markdown file, GitHub issue, YAML feature brief, or any natural-language description

---

Installation

Option 1: npm (Recommended)

npm install -g loki-mode

Option 2: Homebrew (macOS/Linux)

brew install asklokesh/tap/loki-mode

Option 3: Docker

docker pull asklokesh/loki-mode

Verify Installation

loki --version
# Output: Loki Mode v5.49.0

---

Your First Session

Step 1: Create a spec

A spec can be a PRD markdown file, a GitHub issue, or a YAML brief. The simplest is a markdown PRD. Create a file called my-app.md:

# My Todo App

## Overview
Build a simple todo application with React and localStorage.

## Requirements
- [ ] Add new todos with a text input
- [ ] Mark todos as complete
- [ ] Delete todos
- [ ] Persist todos in localStorage
- [ ] Responsive design

## Tech Stack
- React 18
- TypeScript
- TailwindCSS

Step 2: Start Loki Mode

# Launch Claude with autonomous permissions
claude --dangerously-skip-permissions

# In Claude, invoke:
# "Loki Mode with spec at my-app.md"
# (also accepts: "with PRD at my-app.md", "from issue #42", etc.)

Or use the CLI directly:

loki start my-app.md

Step 3: Monitor Progress

Open the dashboard:

loki dashboard open

Or check status via CLI:

loki status
loki logs --follow

---

Quick Examples

Start from GitHub Issue

# Use a GitHub issue as the spec (converts issue body to a PRD and starts)
loki issue https://github.com/owner/repo/issues/123 --start

Run in Background

loki start my-app.md --background
loki logs --follow  # Monitor progress

Use Different Provider

loki start my-app.md --provider codex
loki start my-app.md --provider gemini

Enable Parallel Mode

loki start my-app.md --parallel

---

Session Control

Command	Description
loki status	Check current session status
loki pause	Pause after current phase
loki resume	Resume paused session
loki stop	Stop immediately
loki logs	View recent output
loki logs -f	Follow logs in real-time

---

Configuration (Optional)

Create .loki/config.yaml in your project:

core:
  max_retries: 50

dashboard:
  enabled: true
  port: 57374

notifications:
  enabled: true

Or set environment variables:

export LOKI_SLACK_WEBHOOK="https://hooks.slack.com/..."
export LOKI_MAX_RETRIES=100

---

Next Steps

• CLI Reference - Full command documentation
• Configuration - All configuration options
• Use Cases - Real-world examples
• Enterprise Features - Auth, audit, sandbox