Skip to main content

​
The foks binary

The foks binary is the main CLI for FOKS. When invoked as git-remote-foks (a symlink), it acts as a Git remote helper. Most subcommands require the FOKS agent to be running (foks ctl start).

​
Global flags

​
Top-level commands

​
signup

Interactive signup flow. Prompts for a server (default: foks.app), username, and invite code. Creates a new device key and registers it with the server. On servers configured with OAuth2 SSO, signup can be restricted to members of your organization and FOKS usernames are matched to your identity provider’s naming scheme. Your resulting identity is a user@host pair, e.g. alice@foks.app.

​
passphrase

Passphrases protect device keys at rest. They are stored only on the local machine; the server never sees them.

​
sso

Re-authenticate with the identity provider (IdP) on a server that has OAuth2 SSO enabled. Prints a URL to open in your browser to complete the OAuth2 flow. Useful when your session has been invalidated — for example, after the server admin reconfigures SSO or your IDP token has expired beyond the refresh window.

​
admin

​
status

Shows the current agent state, logged-in user, pending key rotations, and connectivity to the server.

​
ping

Pings the local agent to confirm it is running and responsive.