GitHub Commands

Ralph integrates with GitHub for authentication and PR creation. These commands manage that integration.

Authentication Commands

Show current authentication status.

ralph auth

Output:

GitHub Authentication:
  Status: Authenticated
  User: username
  Method: OAuth

Authenticate with GitHub using OAuth device flow.

ralph auth login

This initiates the OAuth device flow:

No token needed — this is the recommended authentication method.

Disconnect from GitHub and clear credentials.

ralph auth logout

Removes stored GitHub credentials.

Show GitHub integration status.

ralph github

Output:

GitHub Integration:
  Status: Connected
  Repository: owner/repo
  Default branch: main

Set a personal access token (legacy method).

ralph github set-token <token>

Arguments:

Argument	Description
`<token>`	GitHub personal access token

Note: Using ralph auth login with OAuth is preferred over personal access tokens.

Remove stored GitHub credentials.

ralph github clear-token

Alias for ralph auth logout.

ralph auth login

ralph github set-token ghp_xxxxx

Ralph requires these GitHub permissions:

Permission	Purpose
`repo`	Access to repositories
`read:user`	Read user profile

When using ralph auth login, you’ll see exactly what permissions are requested.

When authenticated, Ralph can create pull requests from completed work. This happens automatically at the end of a session when configured.

Run ralph auth login to authenticate:

ralph auth login

If using a personal access token, generate a new one and update:

ralph github set-token <new-token>

Or switch to OAuth:

ralph auth logout
ralph auth login

Ralph detects the repository from your git remote. Ensure you’re in the correct directory and have a proper remote configured:

git remote -v