Revue documentation

Revue is a free desktop app for reviewing pull requests on GitHub, Bitbucket Cloud and Forgejo (Codeberg, your own server, or Gitea), with Jira tickets and Slack threads next to them. It runs on Linux, Windows and macOS.

New to Revue?#

1. Install Revue and sign in to your first account.
2. Open a pull request from the list, read the diff, comment, and submit your review: Review a pull request from start to finish.
3. Look around the step-by-step guides for the things people do most.

Getting started#

• Getting started: install on Linux, Windows or macOS, the first start, your first review.
• Step-by-step guides: short recipes for common tasks.
• Accounts and signing in: several accounts and servers, browser sign-in or tokens, where tokens are kept.
• Revue account: optional; sign in once and your sign-ins follow you to every computer, end-to-end encrypted.

Services#

• GitHub
• Bitbucket Cloud
• Forgejo, Codeberg and Gitea, including setting up a server for browser sign-in.
• Jira: tickets in tabs next to their pull request.
• Slack: reply in a pull request's thread when you review it, announce the ones you open.

Reviewing#

• The pull request list, tabs and search: what needs you, every account in one list, Ctrl+K to find anything.
• Reviewing the diff: split or unified, viewed files, any range of commits.
• Comments, threads and drafts: line and range comments, suggestions, the conversation timeline, drafts saved to disk.
• Reviews, approvals, merging and editing: submitting your review, approvals, checks, conflicts, editing a pull request, and where merging happens.
• Stacked pull requests: pull requests built on each other.
• Opening a pull request: from a branch, with reviewers, labels and a Jira ticket.

Code and local work#

• Browsing code: the whole repository at the pull request's commit, search, go to definition.
• Language servers: what Revue runs for code navigation, and how to choose.
• Clones, worktrees and opening in your tools: check a pull request out and open it in your editor, terminal or AI assistant.
• Repositories and branches: history, branches and code of any repository.
• Links and opening from anywhere: revue <link>, revue:// links, the bookmarklet, Revue links to share.
• Editors: JetBrains IDEs: open or create your branch's pull request from your editor, and list the repository's open ones.

Customising#

• Themes, fonts, focus mode and languages
• Files, sync and settings for one computer: where Revue keeps things, and syncing it between computers.
• Updates

Reference#

• Settings reference: every setting, its options and default.
• Keyboard shortcuts: every shortcut.
• Command line and environment variables

Help#

• Troubleshooting and FAQ
• Privacy and security: what Revue stores, and what it talks to.
• Self-hosting revue-server: the website, image host and link pages, on your own server.
• Building from source and contributing: build Revue yourself, use your own OAuth apps, translate it.

Found a mistake, or something missing? Open an issue.