Git-native cross-forge collaboration: posts, issues, PRs, releases, all in your repo
How It Works • Extensions • Installation • Quick Start • Documentation • Contributing
How It Works
- Everything is a commit: posts, issues, PRs, releases stored on
gitmsg/*branches - Syncing is git:
git fetchto update,git pushto publish; works offline and peer-to-peer - Portable:
git clone --mirror, no export tools needed - CLI, TUI, and JSON-RPC interfaces
Extensions
| Extension | Status | Description |
|---|---|---|
| Social | Stable | Posts, comments, reposts, lists, timeline |
| PM | Stable | Issues, milestones, sprints, boards |
| Review | Stable | Cross-forge PRs, version-aware reviews (see more) |
| Release | Stable | Releases, artifacts, checksums, signatures, SBOM |
Installation
Homebrew (macOS / Linux):
brew install gitsocial-org/tap/gitsocial
If macOS blocks the binary ("cannot verify developer"), run:
xattr -d com.apple.quarantine $(which gitsocial)Scoop (Windows):
scoop bucket add gitsocial https://github.com/gitsocial-org/scoop-bucket.git scoop install gitsocial
Shell script (macOS / Linux):
curl -fsSL https://raw.githubusercontent.com/gitsocial-org/gitsocial/main/install.sh | shGo:
go install github.com/gitsocial-org/gitsocial/library/cli@latest
Or download a binary manually from Releases.
Quick Start
Import an existing project and explore it in the TUI:
git clone https://github.com/your/repo cd repo gitsocial import # imports issues, PRs, releases, discussions gitsocial tui
CLI Walkthrough
Start from scratch with the CLI:
# Initialize GitSocial in your repo cd repo gitsocial social init # Create a list and follow a repository gitsocial social list create reading gitsocial social list add reading https://github.com/someone/interesting-project # Fetch updates and view timeline gitsocial fetch gitsocial social timeline # Write a post gitsocial social post "First post from GitSocial" # Publish gitsocial push
Documentation
GitReview Flows - PR workflows and cross-forge scenarios
Developer Docs
| Document | Description |
|---|---|
| Architecture | System design, packages, cache, and dependencies |
| CLI Reference | Commands, flags, output formats, and scripting |
| TUI Diagrams | ASCII layouts for every list and detail view |
| JSON-RPC | Client integration over stdio |
Protocol Specs
| Spec | Description |
|---|---|
| GITMSG.md | Core message format, headers, refs, and versioning |
| GITSOCIAL.md | Posts, comments, reposts, quotes, and lists |
| GITPM.md | Issues, milestones, sprints, and hierarchy |
| GITREVIEW.md | Pull requests, inline feedback, and review states |
| GITRELEASE.md | Releases with artifacts, checksums, signatures, and SBOM |
Contributing
Platform issues and PRs are disabled on all mirrors — GitSocial uses its own tools for collaboration.
Getting Started
- Install GitSocial (see Installation)
- Fork the repository on any host (GitHub, GitLab, Codeberg, or self-hosted)
- Clone your fork:
git clone https://your-host.com/you/gitsocial
Submitting Pull Requests
git checkout -b feature/my-change # make changes, commit gitsocial review pr create \ --base main \ --head feature/my-change \ "Short description of change" git push origin feature/my-change # push your branch gitsocial push # push PR metadata
After your first push, request fork registration in the Matrix room so maintainers can discover your PRs and issues.
See GitReview Flows for the full cross-forge PR workflow.
Reporting Bugs & Requesting Features
gitsocial pm issue create "Bug: description"
gitsocial pushFor quick questions or discussion, use the Matrix room.
License
MIT
