What is Octree?
Octree is an AI-powered LaTeX editor that brings intelligent writing assistance to academic and technical document creation. Write LaTeX in a Monaco-based editor, chat with Claude for help, and compile to PDF — all in one place.
Getting Started
Prerequisites
- Node.js 18+
- Docker and the Supabase CLI for the local database, or a hosted Supabase project
- Go 1.21+ and a TeX distribution with
latexmk (e.g. MacTeX or TeX Live) for the compile service
- A Stripe account (for billing)
- A Claude API key (for AI features)
Setup
git clone https://github.com/octree-labs/octree.git
cd octree
npm install
npm install --prefix services/agent
Copy the example environment file and fill in your keys:
cp .env.example .env.local
The agent server reads services/agent/.env (see Hosting the agent server). The compile service needs no configuration locally.
Start everything from the repo root — local Supabase, then the Next.js app, agent server, and compile service in one terminal:
npm run dev:all
Supabase and the agent server are required for auth and AI features. The compile service is only needed for PDF compilation. To use a hosted Supabase project instead of the local stack, point the Supabase variables in .env.local at your project; supabase start then isn't needed, so run the services individually (npm run dev, npm --prefix services/agent run dev, make -C services/compile run).
Commands
| Command | Description |
|---|
npm run dev:all | Start local Supabase, the Next.js app, agent server, and compile service |
npm run dev | Start the Next.js dev server only (Turbopack) |
npm run build | Production build |
npm run lint | Run ESLint |
npm run test | Run all tests (Vitest) |
npm run test:watch | Watch mode |
npm run resume:redesign -- <resume.pdf> | Run the resume redesign pipeline locally (needs ANTHROPIC_API_KEY and latexmk) |
Tech Stack
| Layer | Technology |
|---|
| Framework | Next.js 15 (App Router) |
| Language | TypeScript (strict mode) |
| UI | React 19, shadcn/ui, Tailwind CSS |
| Editor | Monaco Editor |
| Database | Supabase (PostgreSQL) |
| Auth | Supabase Auth and Googel OAuth |
| AI | Vercel AI SDK, @ai-sdk/anthropic |
| Payments | Stripe |
| Hosting | Vercel |
Security
If you find a security vulnerability, please email [email protected] instead of opening a public issue.
Self-Hosting
Hosting the compile service
The LaTeX compile service lives in services/compile/ (Go + TeX Live). The Next.js app talks to it through COMPILE_SERVICE_URL (server-side relay at app/api/compile-pdf/) and NEXT_PUBLIC_COMPILE_SERVICE_URL (direct browser calls).
- API:
POST /compile takes { files: [{ path, content }], projectId?, lastModifiedFile? } and returns raw PDF bytes (application/pdf) on success, or JSON with error, log, stdout, stderr on failure. POST /synctex maps between source and PDF positions; GET /health reports queue status.
- Auth: when
SUPABASE_JWT_SECRET is set, /compile and /synctex require Authorization: Bearer <supabase-access-token>. Leave it unset for local development.
- Docker: see
services/compile/deployments/ and services/compile/README.md. The deploy scripts in services/compile/deploy/ read the target host from SERVER_IP, or DEPLOY_HOST / STAGING_DEPLOY_HOST in services/compile/.env. They never sync .env: the production .env (with SUPABASE_JWT_SECRET) lives only on the server.
Hosting the agent server
The AI editing agent is included in this repo under services/agent/ and can be hosted independently.
Local/dev run
cd services/agent
npm install
cp ../../.env.example .env
# Fill required values in services/agent/.env (see below)
npm run dev
The service starts on http://localhost:8787 and exposes POST /agent.
Production (Docker)
cd services/agent
docker build -t octra-agent:latest .
docker compose up -d
docker-compose.yml maps port 8787:8787 and reads environment variables from services/agent/.env.
Required environment variables for agent server
ANTHROPIC_API_KEY (required)SUPABASE_JWT_SECRET (optional but recommended; when set, /agent requires Bearer JWT)SUPABASE_URL (optional; also accepts tokens signed with the project's asymmetric JWT signing keys, e.g. local supabase start stacks)COMPILE_SERVICE_URL (optional; enables agent compile tool)PORT (optional; defaults to 8787)
Connect the Next.js app to your hosted agent
Set in .env.local:
CLAUDE_AGENT_SERVICE_URL=http://localhost:8787
If hosting remotely, replace with your public/internal URL.
License
LGPL-3.0 — see LICENSE for details.
