Quickstart

Install dx

Choose your preferred installation method:

One-liner installation (Recommended)

Interactive install

curl -fsSL https://usedx.sh | sh

The installer script is plain text and hosted at https://usedx.sh/install (GitHub Pages) — inspect before running.

Non-interactive install

curl -fsSL https://usedx.sh | sh -s -- -y

Perfect for CI/CD environments and automated deployments.

Direct download (Alternative)

macOS

# Apple Silicon
sudo curl -fsSL https://usedx.sh/dl/dx-darwin-arm64 -o /usr/local/bin/dx && sudo chmod +x /usr/local/bin/dx

# Intel
sudo curl -fsSL https://usedx.sh/dl/dx-darwin-amd64 -o /usr/local/bin/dx && sudo chmod +x /usr/local/bin/dx

Linux

# x86_64
sudo curl -fsSL https://usedx.sh/dl/dx-linux-amd64 -o /usr/local/bin/dx && sudo chmod +x /usr/local/bin/dx

# Without sudo (to ~/.local/bin):
mkdir -p "$HOME/.local/bin"
curl -fsSL https://usedx.sh/dl/dx-linux-amd64 -o "$HOME/.local/bin/dx" && chmod +x "$HOME/.local/bin/dx"

First use

Once installed, try dx with a simple demo:

Bootstrap demo

sh -c '
set -e
mkdir -p demo-dx && cd demo-dx
cat > MOTD.md <<"MOTD"
<!-- dx:ascii -->
████╗   ████╗
Welcome to dx demo
MOTD
cat > menu.toml <<"MENU"
[[items]]
name = "Show Git status"
description = "git status in the current repo"
cmd = "git status || echo 'Not a git repo'"

[[items]]
name = "README.md"
description = "View local README (Markdown)"
file = "README.md"
MENU
cat > README.md <<"DOC"
# Demo README

- Use Up/Down / j/k to move
- q or Esc to quit
DOC
dx
'

Basic usage

Run dx

dx                # auto-detects menu.toml and MOTD.md
dx README.md      # open a file directly

Create menu.toml

Set up your project’s command menu and documentation.

Markdown support

Rich Markdown rendering with clickable footnotes.

Development setup

Set up dx for local development and contribution.

Need help? Check out our GitHub repository or create an issue.

dx - Terminal DX Manifesto

Getting started

Configuration

Features

AI Native

Install dx

One-liner installation (Recommended)

Direct download (Alternative)

First use

Basic usage

Run dx

Create menu.toml

Markdown support

Development setup

​Install dx

​One-liner installation (Recommended)

​Direct download (Alternative)

​First use

​Basic usage

Run dx

Create menu.toml

Markdown support

Development setup

Install dx

One-liner installation (Recommended)

Direct download (Alternative)

First use

Basic usage