Quick start

ScionHub is a hosted ScionHub core. Everything below also works against your own server; see the source.

1. Install the client

curl -fsSL https://scionhub.io/install.sh | sh
# or download https://scionhub.io/dl/shc-<os>-<arch> and put it on your PATH

2. Sign in and create a repository

Sign in with GitHub or Google. Your account is a tenant: repositories live under <you>/ and you are their admin. Create one from Repositories.

3. Mint a token

On Tokens, create a token for yourself (every right on every repository of your tenant) or for an agent (one repository, Read/Write or Read). A token is shown once, together with the shc login line that saves it on your machine (~/.config/shc/hosts.json, readable only by you). After that no command needs a token: a workspace uses the login of its server, and outside a workspace the only login is the default server.

shc login tls://core.scionhub.io:443        # prompts for the token; or --token … as shown on the Tokens page
shc whoami

Agents and CI keep the token in SHC_TOKEN instead, or pass --token; both win over the saved login.

4. Clone, commit, land

shc init tls://core.scionhub.io:443 you/project ./project          # an empty workspace bound to the repository
cd project && echo "# project" > README.md
shc commit -m "initial" --land                                 # first changeset of an empty repository
cd project
echo "hello" > README.md
shc commit -m "add README" --land
shc log -n 3
shc clone tls://core.scionhub.io:443 you/project other --sparse src,docs   # sparse checkout

shc update moves the workspace to the tip and merges your uncommitted edits three-way. A conflicting land exits non-zero with the conflicting paths; fix and land again.

5. Agents

# a Read/Write token for agent "bot" on you/project, from the Tokens page, in the agent's environment
export SHC_TOKEN="$BOT_TOKEN"
shc clone tls://core.scionhub.io:443 you/project bot --name bot
cd bot && …edit… && shc commit -m "bot change" --land

Path rules, review rules and the landing policy of main are managed with shc admin and shc review rules using your own token.

6. Verification and auto-revert

shc-verify -server tls://core.scionhub.io:443 -repo you/project -ref main -- go test ./...
# advances main/verified on green, bisects and reverts on red (3 reverts per hour by default)

Endpoints