Flux Client Documentation

Getting Started

Prerequisites

• Windows 10/11, macOS, or Linux
• Git 2.0+ installed on your system
• A GitHub account (for cloud features)

Installation

Architecture Overview

Flux Client combines a modern React frontend with a robust Electron backend.

Multi-Account Management

Seamlessly switch between Personal, Work, and Client GitHub accounts without logging out.

• Add Account: Click the "+" icon in the left sidebar to authenticate via GitHub OAuth.
• Context Switching: Click an avatar to activate that account. The active account is used for all pushes, pulls, and API calls.
• Security: tokens are encrypted at rest using machine-specific keys.

Changes & Staging

The Changes Tab (Ctrl+1) is your main workspace.

• Visual Diff: Click any file to see side-by-side changes in the Monaco diff editor.
• Stage/Unstage: Use the "+" and "-" buttons or "Stage All".
• Commit: Write a message and press Ctrl+Enter to commit.

Commit History

View the log in the History Tab (Ctrl+3).

• Filtering: See commits for the current branch.
• Details: Click a commit to see full details, changed files, and parent hashes.
• Actions: Revert, cherry-pick, or checkout commits directly from the context menu.

Branch Management

Manage local and remote branches in the Branches Tab (Ctrl+4).

Cloud Repositories

The Cloud Tab (Ctrl+5) lists all repositories from your connected GitHub account.

• Clone: One-click clone to your local machine.
• Create: Initialize new repos locally or on GitHub.
• Manage: Toggle visibility (public/private) or rename repos.

GitHub Actions

Monitor CI/CD pipelines in the Actions Tab (Ctrl+8). View live logs, cancel runs, or re-run failed jobs without opening the browser.

Integrated Terminal

Flux Client includes a full xterm.js terminal (Ctrl+J). It automatically injects your GitHub credentials, so you can run `git push` without prompts.

Keyboard Shortcuts