Skip to content
authx-rs

authx CLI

The authx binary (authx-cli crate) provides a full CLI for running and managing an authx-rs server.

Installation

Section titled “Installation”
Terminal window
cargo install --path crates/authx-cli
# or, once published:
cargo install authx-cli

Commands

Section titled “Commands”

authx serve

Section titled “authx serve”

Start the HTTP server.

Terminal window
authx serve [OPTIONS]


Options:
  --bind <BIND>                   Bind address [env: AUTHX_BIND] [default: 0.0.0.0:3000]
  --database-url <DATABASE_URL>   Postgres URL [env: DATABASE_URL]
  --trusted-origins <ORIGINS>     Comma-separated CSRF origins [env: AUTHX_TRUSTED_ORIGINS]
  --session-ttl <SECS>            Session TTL seconds [default: 2592000]
  --secure-cookies                Enable Secure cookie flag
  --rate-limit <N>                Requests/IP/minute [default: 30]
  --lockout-failures <N>          Failures before lockout [default: 5]
  --lockout-minutes <N>           Lockout window minutes [default: 15]

Example:

Terminal window
DATABASE_URL=postgres://user:pass@db/authx \
AUTHX_TRUSTED_ORIGINS=https://app.example.com \
authx serve --bind 0.0.0.0:8080 --secure-cookies

Without DATABASE_URL, the server uses an in-memory store (useful for development).

authx migrate

Section titled “authx migrate”

Apply pending database migrations.

Terminal window
authx migrate --database-url postgres://user:pass@host/db
# or via env:
DATABASE_URL=postgres://… authx migrate

Run this before starting the server for the first time, and after every upgrade.

authx user list

Section titled “authx user list”
Terminal window
authx user list [--offset N] [--limit N]

authx user create

Section titled “authx user create”
Terminal window
authx user create <email> [--username <username>]

authx key generate

Section titled “authx key generate”

Generate a new API key for a user. The raw key is printed once.

Terminal window
authx key generate <user-uuid> [--name "CI pipeline"] [--scopes "read,write"]

authx key list

Section titled “authx key list”
Terminal window
authx key list <user-uuid>

authx key revoke

Section titled “authx key revoke”
Terminal window
authx key revoke <user-uuid> <key-uuid>

Environment variables

Section titled “Environment variables”

All --flag options have env: equivalents — see authx serve --help for the full list. A .env file is supported if you load it before invoking the binary (e.g. via dotenv).