Authentication
One CLI, many environments. Cloud and every self-hosted cluster side by side.
Wordcab SDKs, CLI tools, Helm charts, model weights, and deployment packages are delivered directly to each customer for self-hosted installation. They are not publicly published package-manager artifacts, so install commands in these docs are placeholders until your Wordcab team provides your private package source or offline bundle.
The CLI stores credentials per named environment. One host, many environments — cloud and several self-hosted clusters can be configured side by side, and you switch between them with a flag or an env var.
Log in (cloud)
wordcab login
# opens a browser, completes an OAuth flow, caches the token in ~/.wordcab/config.yml under the "default" environmentNon-interactive (CI)
# Simpler: export the API key
export WORDCAB_API_KEY=wc_live_xxxxxxxx
# Or authenticate programmatically
wordcab login --api-key $WORDCAB_API_KEY --env defaultAdd a self-hosted environment
wordcab login \\
--env on-prem \\
--base-url https://wordcab.apps.example.com \\
--api-key wc_sh_xxxxxxxxSwitch environments
wordcab --env on-prem calls list # per-command override
export WORDCAB_ENV=on-prem # per-shell
wordcab env set on-prem # per-host defaultInspect credentials
wordcab env list # which environments are configured
wordcab whoami # identity, key prefix, scopes, current environment
wordcab ping # tests the network + auth path end to endLog out
wordcab logout # current environment
wordcab logout --env on-prem # specific environment
wordcab logout --all # drop every cached credentialConfiguration file
All config lives in ~/.wordcab/config.yml. It is YAML, safe to commit per-user, and can be overridden with --config /path/to/other.yml.
current_environment: default
environments:
default:
base_url: https://api.wordcab.com
api_key_ref: $WORDCAB_API_KEY # resolve at runtime
on-prem:
base_url: https://wordcab.apps.example.com
api_key_file: ~/.wordcab/onprem.key
ca_bundle: /etc/ssl/certs/example-root.crt
staging:
base_url: https://wordcab-staging.apps.example.com
api_key_file: ~/.wordcab/staging.keyOn production hosts, prefer api_key_file (mode 0600) or a credential helper (Vault, AWS Secrets Manager, keychain) over plaintext. The CLI shells out to exec entries when present — see wordcab env config --help.