Skip to content

Update README installation section to recommend uv tool and pipx #1

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

Open
chandrasekharan-zipstack wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README installation section to recommend uv tool and pipx #1

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
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,26 @@ Command-line tool for the [mfbt](https://mfbt.ai) platform. Provides both an int
- **Real-time Updates** -- WebSocket-powered job monitoring and status tracking
- **Agent Orchestration** -- Auto-invoke coding agents to implement pending features with `mfbt ralph`

## Requirements
## Installation

- Python 3.10+
### Recommended

## Installation
```bash
# Using uv (no Python required)
uv tool install mfbt-cli

# Using pipx
pipx install mfbt-cli
```

### Alternative

```bash
pip install mfbt-cli
```

Requires Python 3.10+. Using `uv tool install` or `pipx` is preferred as they handle isolation and PATH setup automatically.

## Quick Start

```bash
Expand Down
Loading