CLI Reference

Sendword provides a set of subcommands for serving, managing users, and handling backups.

serve

Start the HTTP server:

sendword serve

This is the default command. It starts the Axum web server, runs database migrations, and begins listening for webhook requests.

export

Export the current configuration as JSON to stdout:

sendword export > config.json

import

Import configuration from a JSON file:

sendword import config.json

Validates the config before applying. Returns detailed errors on validation failure.

user create

Create a new user interactively:

sendword user create --username admin

Prompts for a password. Passwords are stored with bcrypt hashing.

backup create

Create a backup and upload to S3:

sendword backup create

Requires [backup] section in config.

backup list

List available backups in S3:

sendword backup list

restore

Restore from a backup:

sendword restore --from backups/sendword-2024-01-15.tar.gz --output ./restored