#bit

Warning: This is an experimental implementation. Do not use in production. Data corruption may occur in worst case scenarios. Always keep backups of important repositories.

#Install

# One-line install
curl -fsSL https://raw.githubusercontent.com/mizchi/bit-vcs/main/install.sh | bash

# Or install via MoonBit toolchain
moon install mizchi/bit/cmd/bit

#Subdirectory Clone

# Using @user/repo/path shorthand
bit clone mizchi/bit-vcs:src/x/fs

# Or paste GitHub browser URL
bit clone https://github.com/user/repo/tree/main/packages/core

# Single file download
bit clone https://github.com/user/repo/blob/main/README.md

#Standard Git Commands

bit clone https://github.com/user/repo
bit checkout -b feature
bit add .
bit commit -m "changes"
bit push origin feature

#Compatibility

• Hash algorithm: SHA-1 only.
• SHA-256 repositories and --object-format=sha256 are not supported.
• Git config: reads global aliases from ~/.gitconfig (or GIT_CONFIG_GLOBAL) only.
• Shell aliases (prefixed with !) are not supported.

#Standalone Test Coverage (Current)

• repository lifecycle and core porcelain: init, status, add, commit, branch, checkout/switch, reset, log, tag
• transport-style workflows in standalone mode: clone, fetch, pull, push, bundle
• plumbing used by normal flows: hash-object, cat-file, ls-files, ls-tree, write-tree, update-ref, fsck
• feature flows: hub, ai (rebase, merge, cherry-pick, revert, commit; rebase-ai is alias), mcp, hq

#Explicitly Unsupported In Standalone Mode

• signed commit modes (commit -S, commit --gpg-sign)
• interactive rebase (rebase -i)
• reftable-specific paths (clone --ref-format=reftable, update-ref on reftable repo)
• cloning from local bundle file (clone <bundle-file>)
• SHA-256 object-format compatibility paths (hash-object -w with compatObjectFormat=sha256, write-tree on non-sha1 repo)
• cat-file --batch-all-objects with %(objectsize:disk)
• unsupported option sets for index-pack and pack-objects

#Where Git Fallback Exists

• Main bit command dispatch in src/cmd/bit/main.mbt does not auto-delegate unknown commands to system git.
• Git fallback/delegation is implemented in the shim layer tools/git-shim/bin/git.
  • The shim delegates to SHIM_REAL_GIT by default.
  • CI git-compat (.github/workflows/ci.yml) runs upstream git/t via this shim (SHIM_REAL_GIT, SHIM_MOON, SHIM_CMDS).

#Environment Variables

• BIT_BENCH_GIT_DIR: override .git path for bench_real (x/fs benchmarks).
• BIT_PACK_CACHE_LIMIT: max number of pack files to keep in memory (default: 2; 0 disables cache).
• BIT_RACY_GIT: when set, rehash even if stat matches to avoid racy-git false negatives.

#Extensions

#Fs - Virtual Filesystem

let fs = Fs::from_commit(fs, ".git", commit_id)
let files = fs.readdir(fs, "src")
let content = fs.read_file(fs, "src/main.mbt")

#Kv - Distributed KV Store

let db = Kv::init(fs, fs, git_dir, node_id)
db.set(fs, fs, "users/alice/profile", value, ts)
db.sync_with_peer(fs, fs, peer_url)

#Hub - Git-Native Huboration

let hub = Hub::init(fs, fs, git_dir)
let pr = hub.create_pr(fs, fs, "Fix bug", "...",
  source_branch, target_branch, author, ts)

#License