Skip to content

About

A fast, native GitHub Desktop for Linux, rewritten in Rust with libcosmic.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Latest commit

Β 

History

7 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

GitHub ReDesktop logo

GitHub ReDesktop

A fast, native GitHub Desktop for Linux, rewritten in Rust with libcosmic.

🌐 regit.v.bzh

CI Release License: MIT Rust Platforms NixOS

Changes view

GitHub ReDesktop brings the workflow of GitHub Desktop to Linux as a native application: no Electron, no web view, a single small binary that starts instantly and follows your desktop theme. It is built with the COSMIC toolkit, so it looks right at home on Pop!_OS/COSMIC and works on any Wayland or X11 desktop.

✨ Features

Changes Live list of changed files with status badges, per-file checkboxes to choose what goes into the commit, colored line-numbered diff, summary + description, amend last commit
History Paginated commit list with refs and unpushed markers, commit details, changed files and their diff
Branches Searchable branch picker, create / switch / rename / delete, check out remote branches, merge into the current branch, abort a merge, conflict banner
Sync Smart Fetch / Pull / Push / Publish button with ahead/behind counters, background fetch every 5 minutes, force push with lease
GitHub Sign in with a token or reuse your gh CLI login, clone from your repository list, publish a local repository to GitHub, open repo / commit / compare pages
Commits Undo last commit, revert, cherry-pick, create a branch from a commit, copy SHA
Files Discard changes (untracked files go to the trash), ignore a file or an extension, copy path, reveal in the file manager
Stash Stash everything (including untracked files) and restore it in one click
Integrations Open in your editor (VS Code, Zed, COSMIC Edit, …), terminal (COSMIC Terminal, Ghostty, Kitty, …) or file manager β€” auto-detected
Desktop Dark / light / follow-the-system theme, English & French UI, keyboard shortcuts, single instance
History view Light theme
History Light theme

πŸ“¦ Installation

Grab the latest packages from the Releases page. Every release ships x86_64 and aarch64 builds. git is the only runtime requirement.

Debian / Ubuntu / Pop!_OS (.deb)

sudo apt install ./github-redesktop_*_amd64.deb     # or *_arm64.deb

Fedora / RHEL / openSUSE (.rpm)

sudo dnf install ./github-redesktop-*.x86_64.rpm    # or *.aarch64.rpm

Any distribution (.tar.gz)

tar xzf github-redesktop-*-linux-x86_64.tar.gz
cd github-redesktop-*-linux-x86_64
./install.sh            # installs into ~/.local
sudo ./install.sh /usr  # or system-wide

NixOS / Nix ❄️

Try it without installing:

nix run github:Kisakay/GithubReDesktop

Add it to your NixOS configuration with the flake module:

# flake.nix
{
  inputs.github-redesktop.url = "github:Kisakay/GithubReDesktop";

  outputs = { nixpkgs, github-redesktop, ... }: {
    nixosConfigurations.my-host = nixpkgs.lib.nixosSystem {
      modules = [
        github-redesktop.nixosModules.default
        { programs.github-redesktop.enable = true; }
      ];
    };
  };
}

The flake serves the prebuilt release binary (patched for NixOS with autoPatchelf), so installing takes seconds instead of compiling. After each release, CI pins the tarball hashes in nix/release.json; releases are immutable, so those hashes never change. To build from source instead, use packages.<system>.github-redesktop-source.

Also available: overlays.default (adds pkgs.github-redesktop), homeManagerModules.default (programs.github-redesktop.enable) and packages.<system>.default.

πŸ” Signing in to GitHub

Open Settings (gear icon) and either:

  • click Use GitHub CLI login if you are already authenticated with gh, or
  • paste a personal access token with the repo, read:org and workflow scopes.

The token is stored in your system keyring (Secret Service: GNOME Keyring, KWallet, …) and falls back to a 0600 file in ~/.config/github-redesktop/ only when no keyring is available. It is handed to git through a private GIT_ASKPASS helper for HTTPS remotes; SSH remotes keep using your SSH agent.

⌨️ Keyboard shortcuts

Action Shortcut Action Shortcut
New repository Ctrl+N Push Ctrl+P
Add local repository Ctrl+O Pull Ctrl+Shift+P
Clone repository Ctrl+Shift+O Fetch Ctrl+Shift+T
Changes / History Ctrl+1 / 2 New branch Ctrl+Shift+N
Open in editor Ctrl+Shift+A Rename branch Ctrl+Shift+R
Open in terminal Ctrl+` Merge into current Ctrl+Shift+M
Show in file manager Ctrl+Shift+F Stash changes Ctrl+Shift+S
View on GitHub Ctrl+Shift+G Compare on GitHub Ctrl+Shift+C
Settings Ctrl+, Refresh Ctrl+R

πŸ› οΈ Building from source

Requirements: Rust β‰₯ 1.90, git, pkg-config, and the development headers of libxkbcommon, wayland, fontconfig, freetype, expat and dbus.

# Debian/Ubuntu
sudo apt install pkg-config libxkbcommon-dev libwayland-dev libfontconfig1-dev libfreetype-dev libexpat1-dev libdbus-1-dev
# Fedora
sudo dnf install pkgconf libxkbcommon-devel wayland-devel fontconfig-devel freetype-devel expat-devel dbus-devel

git clone https://github.com/Kisakay/GithubReDesktop && cd GithubReDesktop
cargo install just      # optional task runner
just run                # build & run in release mode
sudo just install       # install into /usr

With Nix, nix develop gives you a shell with every dependency, and nix build produces the package.

Useful recipes: just test, just check (clippy), just fmt, just tarball.

🧱 Architecture

src/
β”œβ”€β”€ main.rs        entry point (also acts as the GIT_ASKPASS helper)
β”œβ”€β”€ app.rs         application state, messages and update logic (Elm architecture)
β”œβ”€β”€ config.rs      persistent settings (cosmic-config)
β”œβ”€β”€ github.rs      GitHub REST API client + keyring token storage
β”œβ”€β”€ tools.rs       editor / terminal / file-manager integration, time formatting
β”œβ”€β”€ git/           git backend β€” shells out to `git`, like GitHub Desktop does
β”‚   β”œβ”€β”€ status.rs  `git status --porcelain=v2` parser
β”‚   β”œβ”€β”€ diff.rs    unified diff parser
β”‚   β”œβ”€β”€ log.rs     history & commit files
β”‚   β”œβ”€β”€ branch.rs  branches
β”‚   └── tests.rs   end-to-end tests against a real temporary repository
└── ui/            views: toolbar, changes, history, diff, branches, dialogs, settings, welcome

Every repository operation runs the real git executable, so hooks, credential helpers, signing, includeIf and the rest of your .gitconfig behave exactly like on the command line. Parsers are unit-tested, and an end-to-end test drives a temporary repository through commit, branch, merge, stash, discard, undo and revert.

πŸš€ Releasing

Releases are immutable: each version is published exactly once and its assets are never replaced. Bump version in Cargo.toml (and the <releases> entry in the metainfo), then push a new tag:

git tag v0.2.0 && git push origin v0.2.0

The release workflow builds on native x86_64 and aarch64 runners (Ubuntu 22.04 for broad glibc compatibility), produces the .tar.gz, .deb and .rpm packages and a SHA256SUMS file, and publishes them in a GitHub release (created as a draft with every asset, then published in one step; the job refuses to touch a tag that already has a release). It then commits the tarball hashes to nix/release.json so the flake serves the new binaries. The website workflow deploys regit.v.bzh from site/. The CI workflow runs rustfmt, clippy and the tests, and builds the Nix flake on both architectures.

🌍 Translations

Strings live in i18n/ as Fluent files. To add a language, copy i18n/en/github_redesktop.ftl to i18n/<lang>/ and translate it.

πŸ™ Credits

  • Inspired by GitHub Desktop (MIT). This project is an independent reimplementation and shares no code with it.
  • Built with libcosmic and iced.

GitHub ReDesktop is not affiliated with or endorsed by GitHub, Inc. "GitHub" is a trademark of GitHub, Inc.

πŸ“„ License

MIT Β© Kisakay

About

A fast, native GitHub Desktop for Linux, rewritten in Rust with libcosmic.

Topics

Resources

Stars

1 star

Watchers

0 watching

Forks

Releases

Contributors

Languages