Skip to content
rung

Configuration

Rung requires GitHub authentication to create and manage pull requests.

GitHub Authentication

Section titled “GitHub Authentication”

Rung checks for GitHub authentication in this order:

  1. GITHUB_TOKEN environment variable
  2. GitHub CLI (gh auth token)
Section titled “Using GitHub CLI (Recommended)”

The easiest way to authenticate is with the GitHub CLI:

Terminal window
gh auth login

Rung automatically uses the token from gh auth token.

Using Environment Variable

Section titled “Using Environment Variable”

Alternatively, set the GITHUB_TOKEN environment variable:

Terminal window
export GITHUB_TOKEN=ghp_xxxxxxxxxxxx

Required scopes:

  • repo — Full control of private repositories
  • read:org — Read org membership (for org repos)

State Storage

Section titled “State Storage”

Rung stores its state in .git/rung/:

FilePurpose
stack.jsonBranch relationships and PR numbers
refs/Backup refs for undo capability
sync_state.jsonIn-progress sync state (during conflicts)

This directory is local to your machine and not committed to git.

Section titled “Related”