Documentation

Guides for configuring, theming, and extending dux.

Everything you need to bend dux to your will. Start with the basics, then work through the guides. Every page is a plain Markdown file, so if something's missing or wrong, the edit link at the bottom of each page takes you straight to the source.

Getting started

Introduction

What dux is, the mental model behind it, and how the pieces fit together.

Configuration

Where the config file lives, how it expands environment variables, and the commands that manage it.

Guides

Creating agents

The four ways to spin up an agent in dux (fresh branch, GitHub PR, existing worktree, or fork) and how provider selection works at creation time.

Managing Macros

Define reusable text snippets in config and send them to an agent or terminal with a quick keystroke.

Startup commands & environment variables

How to run per-project setup scripts and inject environment variables into every agent dux creates.

Managing Themes

Switch the built-in themes, preview them live, or write your own from scratch.

Custom CLI Agents

Configure any CLI as a dux provider, no adapters or protocol layer, just config.

Reference

Recommended tools

A curated set of providers, MCP servers, and skills that work well with dux.

FAQ

Quick answers to the small questions about platforms, providers, config, themes, and keybindings.