Docs: Commands

Usage: skeema <command> [<options>]

Skeema is a declarative schema management system for MySQL and MariaDB. It allows you to export a database schema to the filesystem, and apply online schema changes by modifying CREATE statements in .sql files.


skeema add-environmentAdd a new named environment to an existing host directory
skeema diffCompare a DB instance’s schemas to the filesystem
skeema formatNormalize format of filesystem representation of database objects
skeema initSave a DB instance’s schemas to the filesystem
skeema lintCheck for problems in filesystem representation of database objects
skeema pullUpdate the filesystem representation of schemas
skeema pushAlter objects on DBs to reflect the filesystem representation
skeema updateUpdate to the latest version of Skeema Premium CLI

Global Options

connect-optionsComma-separated session options to set upon connecting to each database instance
debugEnable debug logging
helpDisplay usage information for the specified command
host-wrapperExternal bin to shell out to for host lookup; see manual for template vars
ignore-funcIgnore functions that match regex
ignore-procIgnore stored procedures that match regex
ignore-schemaIgnore schemas that match regex
ignore-tableIgnore tables or views that match regex
ignore-triggerIgnore triggers that match regex
ignore-viewIgnore views that match regex
my-cnfParse ~/.my.cnf for configuration (enabled by default; disable with skip-my-cnf)
passwordPassword for database user; omit value to prompt from TTY
server-public-key-pathFile path to server public key in PEM format; omit to obtain from server
sshTunnel MySQL connections thru SSH to this hostname or user@hostname:port
ssh-to-dbSSH to database host in order to establish database connections locally
ssl-caFile path to certificate authority in PEM format
ssl-certFile path to client-side public key in PEM format
ssl-keyFile path to client-side private key in PEM format
ssl-modeSpecify desired connection security SSL/TLS usage
ssl-verify-server-certVerify server-side cert matches server hostname
userUsername to connect to database host
versionDisplay program version