Documentation Index
Fetch the complete documentation index at: https://docs.foks.pub/llms.txt
Use this file to discover all available pages before exploring further.
How it works
FOKS Git repositories are stored in the encrypted key-value store. The git-remote-foks binary (a symlink to foks) acts as a Git remote helper, so standard Git commands (push, pull, clone, fetch) work unchanged against foks:// URLs.
Encryption and decryption happen entirely on the client. The server stores only ciphertext.
Setup
After installing FOKS, create the remote helper symlink (needed once):
make git-link
# or manually:
ln -s $(which foks) $(dirname $(which foks))/git-remote-foks
eval $(foks git shell-config)
foks binary’s directory to your PATH permanently.
Commands
create
foks git create <reponame> [flags]
foks:// URL on success.
foks git create myrepo
# Created: foks://foks.app/alice/myrepo
# Create under a team
foks git create myrepo --team myteam
# Created: foks://foks.app/myteam/myrepo
| Flag | Description |
|---|
--team <team> | Create the repo under a team instead of your user |
foks git ls [flags]
foks git list [flags]
foks git ls
foks git ls --all-teams # include repos for all teams you belong to
| Flag | Description |
|---|
--all-teams | List repos for all teams the current user is a member of |
--json | Output as JSON |
get-default-branch
foks git get-default-branch <reponame>
set-default-branch
foks git set-default-branch <reponame> <branch> [--force]
--force is specified.
Flags:
| Flag | Description |
|---|
--force | Set the default branch even if it doesn’t exist yet |
shell-config
foks git shell-config
foks git env
git-remote-foks to work. Intended to be evaluated in your shell:
eval $(foks git shell-config)
Using with standard Git
Once the symlink is in place and your shell is configured, use foks:// URLs as you would any remote:
# Clone
git clone foks://foks.app/alice/myrepo
# Add as a remote
git remote add origin foks://foks.app/alice/myrepo
git push origin main
# Fetch
git fetch origin
foks://<server>/<owner>/<reponame>
<owner> is your username or a team name.
