Getting Started with livectx

livectx generates intelligent, AI-friendly context files from your codebase. Unlike simple file aggregators, it uses LLM to analyze your code and generate structured context that helps AI assistants understand your project.

Installation

From Go

If you have Go installed:

From Releases

Download the latest binary for your platform from GitHub Releases.

Build from Source

Quick Start

1. Set your API key

livectx uses LLM APIs to analyze your code. Set one of these environment variables:

2. Validate your setup (optional)

Check that everything is configured correctly:

Add --check-api to also test API connectivity:

3. Generate context

Navigate to your project and run:

This creates two files:

• CONTEXT.md — AI-analyzed codebase snapshot with project summary, tech stack detection, key files identified and described, prioritized file contents, and file tree.
• SYSTEM_PROMPT.md — Tailored AI assistant instructions with project overview, coding conventions, architecture patterns, and suggested reading order.

4. Use with AI

Add the generated files to your AI conversation. The AI assistant will now understand your codebase structure, conventions, and key files.

What the Output Looks Like

SYSTEM_PROMPT.md

# MyProject AI Assistant System Prompt

You are an AI assistant specialized in helping developers work with the **myproject** codebase.

## Project Overview
A Next.js e-commerce platform with real-time inventory management and Stripe integration.

## Tech Stack
- **Framework**: Next.js 15 (App Router)
- **Database**: PostgreSQL with Prisma ORM
- **Payments**: Stripe
- **Styling**: Tailwind CSS

## Key Files to Understand
1. `app/api/products/route.ts` — Product CRUD API
2. `lib/stripe.ts` — Stripe integration helpers
3. `prisma/schema.prisma` — Database schema

## Coding Conventions
- Use TypeScript strict mode
- Prefer server components when possible
- Use Zod for API validation

CONTEXT.md

# MyProject Context

## File Tree
```
myproject/
├── app/
│   ├── api/
│   │   └── products/
│   │       └── route.ts
│   ├── layout.tsx
│   └── page.tsx
├── lib/
│   ├── stripe.ts
│   └── db.ts
└── prisma/
    └── schema.prisma
```

## Key Files

### app/api/products/route.ts
Product API with CRUD operations...

```typescript
import { NextResponse } from 'next/server'
import { prisma } from '@/lib/db'
// ... file contents
```

Next Steps