> ## Documentation Index
> Fetch the complete documentation index at: https://usedx.sh/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Install and start using dx in under a minute

## Install dx

Choose your preferred installation method:

### One-liner installation (Recommended)

<AccordionGroup>
  <Accordion icon="terminal" title="Interactive install">
    ```bash theme={null}
    curl -fsSL https://usedx.sh | sh
    ```

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

  <Accordion icon="zap" title="Non-interactive install">
    ```bash theme={null}
    curl -fsSL https://usedx.sh | sh -s -- -y
    ```

    <Tip>Perfect for CI/CD environments and automated deployments.</Tip>
  </Accordion>
</AccordionGroup>

### Direct download (Alternative)

<AccordionGroup>
  <Accordion icon="apple" title="macOS">
    ```bash theme={null}
    # 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
    ```
  </Accordion>

  <Accordion icon="linux" title="Linux">
    ```bash theme={null}
    # 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"
    ```
  </Accordion>
</AccordionGroup>

## First use

Once installed, try dx with a simple demo:

<Accordion icon="play" title="Bootstrap demo">
  ```bash theme={null}
  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
  '
  ```
</Accordion>

## Basic usage

<CardGroup cols={2}>
  <Card title="Run dx" icon="terminal" href="/essentials/code">
    ```bash theme={null}
    dx                # auto-detects menu.toml and MOTD.md
    dx README.md      # open a file directly
    ```
  </Card>

  <Card title="Create menu.toml" icon="file-code" href="/essentials/settings">
    Set up your project's command menu and documentation.
  </Card>

  <Card title="Markdown support" icon="markdown" href="/essentials/markdown">
    Rich Markdown rendering with clickable footnotes.
  </Card>

  <Card title="Development setup" icon="code" href="/development">
    Set up dx for local development and contribution.
  </Card>
</CardGroup>

<Note>
  **Need help?** Check out our [GitHub repository](https://github.com/dx-cli/dx) or create an issue.
</Note>