Skip to content

socifyr configure ​

socifyr configure saves your API key and optional API URL so later commands do not need them.

bash
socifyr configure --key <api-key> [--api-url <url>]
socifyr configure --show

What flags does socifyr configure take? ​

FlagDescriptionDefault
-k, --key <key>API key, starts with sk_not set
--api-url <url>API base URL, for self-hosted or staginghttps://api.socifyr.com/api
--showPrint the current configuration and exitoff

Each flag updates only its own key. Running socifyr configure --api-url <url> leaves the saved API key in place. With no flags the command prints a usage hint and exits with code 0.

How do I save my credentials? ​

bash
socifyr configure --key sk_4b73784c9e1a...
# ✓ Configuration saved
#   API key: sk_4b73784...

Only the first 10 characters of the key are echoed back.

How do I check what is configured? ​

bash
socifyr configure --show
# Current configuration:
#   API key:    sk_4b73784...
#   API URL:    https://staging-api.example.com/api

--show prints the effective API key, so an environment variable shows up here and wins over the file. The API URL line appears only when the config file sets one.

Where is the config file stored? ​

~/.socifyr/config.json, a JSON object with the keys apiKey and apiUrl. The API key is stored in plain text, so keep the file private to your user account.

How do I use the CLI in CI without a config file? ​

Environment variables take precedence over the file:

bash
SOCIFYR_API_KEY=sk_ci... \
  socifyr post "Deploy finished" --to x-myhandle

For a self-hosted instance set SOCIFYR_API_URL, for example https://api.mycompany.com/api.

Next steps ​