# offline-dev-kit

Offline repo-aware coding assistant for local development with Ollama.

## Status

This repository is a starter workspace, not a finished product. Phase 1-6 foundations are implemented: CLI + TUI shell, SQLite memory, repo indexing, Ollama adapter, safe runner with policy/audit trail, daemon API routes with versioned schemas and OpenAPI, prompt profile rendering, SDK-friendly JSON contracts, offline docs ingestion, bootstrap generators with metadata validation, deterministic repository review, session replay, symbol-aware patch planning with deterministic fallback, and structured model outputs.

## Goals

- Work without internet
- Keep durable local memory
- Index repos and local docs
- Run safe, allowlisted commands
- Produce plans, patches, reviews, and session logs

## Primary commands

- `odk ask`
- `odk plan`
- `odk patch`
- `odk debug`
- `odk review`
- `odk replay`
- `odk recall`
- `odk index`
- `odk run`
- `odk bootstrap`
- `odk sync-docs`
- `cargo run -p offline-dev-kit-tui`
- `cargo run -p offline-dev-kit-daemon`

## Quick start

```bash
cp .env.example .env
make check
make test
cargo run -p offline-dev-kit-cli --bin odk -- --help
```

## Install and run

```bash
# install an `odk` binary in your cargo bin dir
cargo install --path apps/cli --bin odk

# run directly from workspace without install
cargo run -p offline-dev-kit-cli --bin odk -- --help
```

## Example

```bash
cargo run -p offline-dev-kit-cli --bin odk -- index --repo ./tests/fixtures/rust_repo
cargo run -p offline-dev-kit-cli --bin odk -- review --repo ./tests/fixtures/rust_repo --format json
cargo run -p offline-dev-kit-cli --bin odk -- replay <session-id> --format markdown
cargo run -p offline-dev-kit-cli --bin odk -- ask "where is auth handled?" --repo ./tests/fixtures/rust_repo
cargo run -p offline-dev-kit-cli --bin odk -- run cargo test --repo ./tests/fixtures/rust_repo
```

## Architecture

See `docs/architecture.md`.

## Daemon API

See `docs/daemon-api.md`.

## Prompt and SDK contracts

See `docs/prompt-contracts.md`.

## Release process

See `docs/release-checklist.md`.

## Production readiness

See `docs/production-readiness.md` for go/no-go gates.
See `docs/operations.md` for support policy, backups, and recovery.