octorus-0.1.6 is not a library.
Visit the last successful build:
octorus-0.1.8
octorus
A TUI tool for GitHub PR review with Vim-style keybindings.
Features
- Browse changed files in a PR
- View diffs with syntax highlighting
- Add inline comments on specific lines
- Add code suggestions
- View and navigate review comments with jump-to-line
- Submit reviews (Approve / Request Changes / Comment)
- Fast startup with intelligent caching
- Configurable keybindings and editor
- AI Rally: Automated PR review and fix cycle using AI agents
Requirements
- GitHub CLI (gh) - Must be installed and authenticated
- Rust 1.70+ (for building from source)
- For AI Rally feature (optional, choose one or both):
- Claude Code - Anthropic's CLI tool
- OpenAI Codex CLI - OpenAI's CLI tool
Installation
Or build from source:
Usage
Options
| Option | Description |
|---|---|
-r, --repo <REPO> |
Repository name (e.g., "owner/repo") |
-p, --pr <PR> |
Pull request number |
--refresh |
Force refresh, ignore cache |
--cache-ttl <SECS> |
Cache TTL in seconds (default: 300) |
Initialize Configuration
Create default config files and prompt templates:
This creates:
~/.config/octorus/config.toml- Main configuration file~/.config/octorus/prompts/- Prompt template directoryreviewer.md- Reviewer agent prompt templatereviewee.md- Reviewee agent prompt templaterereview.md- Re-review prompt template
Keybindings
File List View
| Key | Action |
|---|---|
j / ↓ |
Move down |
k / ↑ |
Move up |
Enter |
Open diff view |
a |
Approve PR |
r |
Request changes |
c |
Comment only |
C |
View review comments |
R |
Force refresh (discard cache) |
A |
Start AI Rally |
? |
Toggle help |
q |
Quit |
Diff View
| Key | Action |
|---|---|
j / ↓ |
Move down |
k / ↑ |
Move up |
Ctrl-d |
Page down |
Ctrl-u |
Page up |
c |
Add comment at line |
s |
Add suggestion at line |
q / Esc |
Back to file list |
Comment List View
| Key | Action |
|---|---|
j / ↓ |
Move down |
k / ↑ |
Move up |
Enter |
Jump to file/line |
q / Esc |
Back to file list |
Configuration
Run or init to create default config files, or create ~/.config/octorus/config.toml manually:
# Editor to use for writing comments
= "vi"
[]
# Syntax highlighting theme for diff view
= "base16-ocean.dark"
[]
= 'a'
= 'r'
= 'c'
= 's'
[]
# AI agent to use for reviewer/reviewee
# Supported: "claude" (Claude Code), "codex" (OpenAI Codex CLI)
= "claude"
= "claude"
# Maximum iterations before stopping
= 10
# Timeout per agent execution (seconds)
= 600
# Custom prompt directory (default: ~/.config/octorus/prompts/)
# prompt_dir = "/custom/path/to/prompts"
Customizing Prompt Templates
AI Rally uses customizable prompt templates. Run or init to generate default templates, then edit them as needed:
~/.config/octorus/prompts/
├── reviewer.md # Prompt for the reviewer agent
├── reviewee.md # Prompt for the reviewee agent
└── rereview.md # Prompt for re-review iterations
Templates support variable substitution with {{variable}} syntax:
| Variable | Description | Available In |
|---|---|---|
{{repo}} |
Repository name (e.g., "owner/repo") | All |
{{pr_number}} |
Pull request number | All |
{{pr_title}} |
Pull request title | All |
{{pr_body}} |
Pull request description | reviewer |
{{diff}} |
PR diff content | reviewer |
{{iteration}} |
Current iteration number | All |
{{review_summary}} |
Summary from reviewer | reviewee |
{{review_action}} |
Review action (Approve/RequestChanges/Comment) | reviewee |
{{review_comments}} |
List of review comments | reviewee |
{{blocking_issues}} |
List of blocking issues | reviewee |
{{external_comments}} |
Comments from external tools | reviewee |
{{changes_summary}} |
Summary of changes made | rereview |
{{updated_diff}} |
Updated diff after fixes | rereview |
AI Rally
AI Rally is an automated PR review and fix cycle that uses two AI agents:
- Reviewer: Analyzes the PR diff and provides review feedback
- Reviewee: Fixes issues based on the review feedback and commits changes
How it works
┌─────────────────┐
│ Start Rally │ Press 'A' in File List View
└────────┬────────┘
▼
┌─────────────────┐
│ Reviewer │ AI reviews the diff
│ (Claude/Codex) │ → Posts comments to PR
└────────┬────────┘
│
┌────┴────┐
│ Approve?│
└────┬────┘
No │ Yes
│ └──→ Done ✓
▼
┌─────────────────┐
│ Reviewee │ AI fixes issues
│ (Claude/Codex) │ → Commits changes locally
└────────┬────────┘
│
▼
Next Iteration
Features
- PR Integration: Review comments are automatically posted to the PR
- External Bot Support: Collects feedback from Copilot, CodeRabbit, and other bots
- Safe Operations: Dangerous git operations (
--force,reset --hard) are prohibited - Session Persistence: Rally state is saved and can be resumed
Keybindings (AI Rally View)
| Key | Action |
|---|---|
j / ↓ |
Scroll log down |
k / ↑ |
Scroll log up |
q / Esc |
Exit rally |
License
MIT