Skip to Content
DocsCLI Reference

CLI Reference

Creddy command-line interface.

Global Flags

FlagDescription
--configPath to config file
--serverServer URL (for client commands)
-v, --verboseVerbose output

Commands

creddy server

Start the Creddy server.

creddy server [flags]
FlagDefaultDescription
--port8080Server port
--host0.0.0.0Host to bind
--data-dir~/.creddyData directory

creddy issue

Issue a new credential.

creddy issue <backend> [flags]
FlagDefaultDescription
--ttlBackend defaultTime to live
--scopeBackend defaultScopes (repeatable)
--metaMetadata key=value (repeatable)
-o, --outputtextOutput format (text, json)

Examples

# Basic usage creddy issue github # With TTL and scopes creddy issue github --ttl 30m --scope repo:read --scope issues:write # With metadata creddy issue github --meta agent=my-agent --meta task=deploy # JSON output creddy issue github -o json

creddy revoke

Revoke a credential.

creddy revoke <credential-id>

creddy backends

List configured backends.

creddy backends [flags]
FlagDescription
-o, --outputOutput format (text, json)

creddy audit

Query the audit log.

creddy audit [flags]
FlagDefaultDescription
--backendFilter by backend
--since24hStart time
--untilEnd time
--limit100Max results
-o, --outputtextOutput format

Examples

# Last 24 hours creddy audit # Specific backend creddy audit --backend github --since 7d # JSON output creddy audit -o json

creddy keys

Manage signing keys.

creddy keys <subcommand>

Subcommands

creddy keys list — List all signing keys

creddy keys list

creddy keys rotate — Generate a new signing key

creddy keys rotate

creddy keys revoke — Revoke a signing key

creddy keys revoke <key-id>

creddy keys export — Export public key

creddy keys export <key-id>

creddy version

Print version information.

creddy version

Environment Variables

VariableDescription
CREDDY_CONFIGConfig file path
CREDDY_SERVERServer URL
CREDDY_DATA_DIRData directory

Exit Codes

CodeDescription
0Success
1General error
2Invalid arguments
3Connection error
Last updated on