Learn how to use Oak VCS
curl -fsSL https://oak.space/install | sh
This downloads the appropriate binary for your platform and installs it to ~/.local/bin.
git clone https://github.com/oakspace/oak
cd oak
make installRequires Rust 1.70 or later.
# Initialize in current directory
oak init
# Initialize in a specific path
oak init myproject
# Initialize local-only (no remote sync)
oak init --local myproject# Check what's changed
oak status
# See the diff
oak diff
# Commit all changes
oak commit -m "Your commit message"# Show commit history
oak log
# Limit number of commits
oak log -n 10Initialize a new Oak repository.
PATH - Directory to initialize (default: current directory)--local - Create local-only repository without remote syncShow the working directory status. Lists modified, added, and deleted files.
Show differences between the working directory and the last commit.
Create a new commit with all changes in the working directory.
-m MESSAGE - Commit message (required)Show commit history.
-n LIMIT - Maximum number of commits to showReset the working directory to a specific commit.
HASH - Commit hash to reset to (default: HEAD)Push local commits to the remote repository.
Pull commits from the remote repository and update working directory.
Start the Oak HTTP server for remote repository hosting.
Open the interactive terminal user interface for browsing repository history.
# Push local commits to remote
oak push
# Pull remote commits and update working directory
oak pullOak automatically creates a remote repository on first push if it doesn't exist.
# List all repositories
curl https://oak.space/api/repos
# Get repository info
curl https://oak.space/api/repos/myrepoURL of the remote Oak server.
Default: https://oak.space
Author name for commits.
Default: System username
Logging level filter.
Example: OAK_LOG=debug
PostgreSQL connection string (server only).
Default: postgres://oak:oak@localhost:5433/oak