Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

CLI Commands

Global Options

rudis-cms --config <CONFIG> <COMMAND>
OptionShortDescription
--config-cPath to configuration file (required)

Commands

batch

Deploy content to Cloudflare.

rudis-cms -c config.yaml batch [OPTIONS]
OptionShortDescription
--force-fForce re-upload all objects
--preview-pDeploy to preview database

Example:

# Normal deployment
rudis-cms -c config.yaml batch

# Force re-upload everything
rudis-cms -c config.yaml batch -f

# Deploy to preview database
rudis-cms -c config.yaml batch --preview

dump

Export to local files for development/testing.

rudis-cms -c config.yaml dump --storage <PATH> --db <PATH>
OptionDescription
--storageDirectory for storage files
--dbDirectory for SQLite database

Example:

rudis-cms -c config.yaml dump --storage ./local-storage --db ./local-db

show-schema

Display generated schemas.

rudis-cms -c config.yaml show-schema <SUBCOMMAND>

show-schema sql

Show SQL DDL statements.

rudis-cms -c config.yaml show-schema sql [OPTIONS]
OptionDescription
--fetch-objectsInclude fetch objects query

show-schema typescript

Generate TypeScript type definitions.

rudis-cms -c config.yaml show-schema typescript [OPTIONS]
OptionDescription
--save <DIR>Save to directory
--valibotGenerate Valibot schemas

Example:

# Print to stdout
rudis-cms -c config.yaml show-schema typescript

# Save with Valibot validation
rudis-cms -c config.yaml show-schema typescript --save ./generated --valibot

Exit Codes

CodeDescription
0Success
1Error

Environment Variables

See Installation for required environment variables.