Skip to content

Latest commit

 

History

History
78 lines (54 loc) · 3.16 KB

index.md

File metadata and controls

78 lines (54 loc) · 3.16 KB

Diffex Documentation

Diffex is a minimal terminal coding harness. It is designed to stay small at the core while being extended through TypeScript extensions, skills, prompt templates, themes, and Diffex packages.

Quick start

Install Diffex with npm:

npm install -g --ignore-scripts @diffexai/diffex

--ignore-scripts disables dependency lifecycle scripts during install. Diffex does not require install scripts for normal npm installs.

To uninstall Diffex, use the matching package manager. For npm installs:

npm uninstall -g @diffexai/diffex

For pnpm, Yarn, or Bun installs, use the matching global remove command: pnpm remove -g @diffexai/diffex, yarn global remove @diffexai/diffex, or bun uninstall -g @diffexai/diffex.

Then run it in a project directory:

diffex

Authenticate with /login for subscription providers, or set an API key such as ANTHROPIC_API_KEY before starting Diffex.

For the full first-run flow, see Quickstart.

Start here

  • Quickstart - install, authenticate, and run a first session.
  • Using Diffex - interactive mode, slash commands, context files, and CLI reference.
  • Providers - subscription and API-key setup for built-in providers.
  • llama.cpp - run a local router and manage models with /llama.
  • Security - project trust, sandbox boundaries, and vulnerability reporting.
  • Containerization - sandbox Diffex with Docker or OpenShell.
  • Settings - global and project settings.
  • Keybindings - default shortcuts and custom keybindings.
  • Sessions - session management, branching, and tree navigation.
  • Compaction - context compaction and branch summarization.

Customization

  • Extensions - TypeScript modules for tools, commands, events, and custom UI.
  • Skills - Agent Skills for reusable on-demand capabilities.
  • Prompt templates - reusable prompts that expand from slash commands.
  • Themes - built-in and custom terminal themes.
  • Diffex packages - bundle and share extensions, skills, prompts, and themes.
  • Custom models - add model entries for supported provider APIs.
  • Custom providers - implement custom APIs and OAuth flows.

Programmatic usage

Reference

  • Environment variables - Diffex process configuration and session metadata available to bash tools.
  • Session format - JSONL session file format, entry types, and SessionManager API.

Platform setup

Development

  • Development - local setup, project structure, and debugging.