Skip to content

docs: recommend pipx for installation #7

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
lklimek merged 1 commit into from
Mar 6, 2026
Merged

docs: recommend pipx for installation #7

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
10 changes: 8 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,12 @@ The write token never appears in agent context or logs — it is encrypted at re

## Installation

```bash
pipx install ghsudo
```

Or with pip:
Comment thread
lklimek marked this conversation as resolved.

```bash
pip install ghsudo
```
Expand All @@ -56,7 +62,7 @@ pip install .

```bash
# 1. Install
pip install ghsudo
pipx install ghsudo

# 2. Create a write-access GitHub PAT at https://github.com/settings/tokens
# (classic PAT with 'repo' scope, or fine-grained with the permissions you need)
Expand Down Expand Up @@ -100,7 +106,7 @@ The key idea: give the agent a read-only token, and instruct it to use `ghsudo`
#### 1. Install ghsudo on your machine

```bash
pip install ghsudo
pipx install ghsudo
```

#### 2. Create a write-access GitHub PAT and store it
Expand Down