Skip to content

docs: move system requirements section under installation #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pmarsceill merged 1 commit into from
Jan 22, 2026
Merged

docs: move system requirements section under installation #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 55 additions & 43 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,61 @@ curl -fsSL https://raw.githubusercontent.com/pmarsceill/mapcli/main/install.sh |

This installs both `map` and `mapd` to `~/.local/bin`. Make sure this directory is in your PATH.

### System Requirements

MAP requires the following tools to be installed and available in your PATH:

| Dependency | Required For | Version |
|------------|--------------|---------|
| **git** | Worktree isolation | 2.15+ (worktree support) |
| **tmux** | Agent session management | Any recent version |
| **claude** | Claude Code agents | Latest (optional if only using Codex) |
| **codex** | OpenAI Codex agents | Latest (optional if only using Claude) |

At least one of `claude` or `codex` must be installed depending on which agent type you want to use.

**Installing Dependencies:**

<details>
<summary>macOS (Homebrew)</summary>

```bash
brew install git tmux
# Claude CLI: https://docs.anthropic.com/en/docs/claude-code
# Codex CLI: https://github.com/openai/codex
```
</details>

<details>
<summary>Ubuntu/Debian</summary>

```bash
sudo apt update && sudo apt install git tmux
# Claude CLI: https://docs.anthropic.com/en/docs/claude-code
# Codex CLI: https://github.com/openai/codex
```
</details>

<details>
<summary>Fedora/RHEL</summary>

```bash
sudo dnf install git tmux
# Claude CLI: https://docs.anthropic.com/en/docs/claude-code
# Codex CLI: https://github.com/openai/codex
```
</details>

<details>
<summary>Arch Linux</summary>

```bash
sudo pacman -S git tmux
# Claude CLI: https://docs.anthropic.com/en/docs/claude-code
# Codex CLI: https://github.com/openai/codex
```
</details>

**Manual installation:**

Download the latest release from the [releases page](https://github.com/pmarsceill/mapcli/releases) and extract the binaries to a directory in your PATH.
Expand Down Expand Up @@ -394,49 +449,6 @@ mapcli/
| `-f, --foreground` | `false` | Run daemon in foreground |
| `-d, --data-dir` | `~/.mapd` | Data directory for SQLite |

## System Requirements

MAP requires the following tools to be installed and available in your PATH:

| Dependency | Required For | Version |
|------------|--------------|---------|
| **git** | Worktree isolation | 2.15+ (worktree support) |
| **tmux** | Agent session management | Any recent version |
| **claude** | Claude Code agents | Latest (optional if only using Codex) |
| **codex** | OpenAI Codex agents | Latest (optional if only using Claude) |

At least one of `claude` or `codex` must be installed depending on which agent type you want to use.

### Installing Dependencies

**macOS (Homebrew):**
```bash
brew install git tmux
# Claude CLI: https://docs.anthropic.com/en/docs/claude-code
# Codex CLI: https://github.com/openai/codex
```

**Ubuntu/Debian:**
```bash
sudo apt update && sudo apt install git tmux
# Claude CLI: https://docs.anthropic.com/en/docs/claude-code
# Codex CLI: https://github.com/openai/codex
```

**Fedora/RHEL:**
```bash
sudo dnf install git tmux
# Claude CLI: https://docs.anthropic.com/en/docs/claude-code
# Codex CLI: https://github.com/openai/codex
```

**Arch Linux:**
```bash
sudo pacman -S git tmux
# Claude CLI: https://docs.anthropic.com/en/docs/claude-code
# Codex CLI: https://github.com/openai/codex
```

## Development

### Prerequisites
Expand Down