Skip to content

Added TUI options to login with PAT and open configuration file #53

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
wham merged 2 commits into from
Dec 27, 2025
Merged

Added TUI options to login with PAT and open configuration file #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1fdaec
Update README.md: Clarify usage instructions for running without glob…
wham Dec 25, 2025
8665848
Refactor: Update authentication flow to use Setup menu and enhance RE…
wham Dec 26, 2025
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
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,13 @@ GitHub Brain is [programmed in Markdown](https://github.blog/ai-and-ml/generativ
npm i -g github-brain
```

Or use `npx github-brain` to run without installing globally.
Rerun to update. `sudo` may be required on some systems.

Alternatively use `npx` to run without installing globally and needing `sudo`.

```sh
npx github-brain@latest
```

## Usage

Expand All @@ -36,7 +42,10 @@ github-brain

Launches the interactive TUI where you can:

1. **Login** - Authenticate with GitHub
1. **Setup** - Configure authentication and settings
- Login with GitHub (OAuth) - Recommended for most users
- Login with Personal Access Token - For fine-grained tokens or when OAuth is unavailable
- Open configuration file - Edit `.env` directly
2. **Pull** - Populate the local database with GitHub data

Re-run pull anytime to update the database with new GitHub data.
Expand Down
Loading