Skip to main content

CLI Reference

auth

The snaplet auth command is used to manage auth state.

Usage

snaplet auth [action]

login

The snaplet auth login command is used to login with an access token.

Usage

snaplet auth login [access-token]

config

The snaplet config command is used to manage configuration.

Usage

snaplet config [action]

create

The snaplet config create command is used to create a new project.

Usage

snaplet config create [name]

Command Flags

NameAliasType
--team-tstring

generate

The snaplet config generate command is used to generate transform files.

Usage

snaplet config generate

Command Flags

NameAliasTypeChoicesDefault
--type-tstringtypedefs,transform,keystypedefs
--dry-runbooleanfalse

list

The snaplet config list command is used to list config variables.

Usage

snaplet config list

pull

The snaplet config pull command is used to pull cloud project config to local.

Usage

snaplet config pull

Command Flags

NameAliasTypeChoicesDefault
--type-tstringschemas,transform,typedefs,publicKeyschemas,transform,typedefs,publicKey

push

The snaplet config push command is used to push local project config to cloud.

Usage

snaplet config push

Command Flags

NameAliasTypeChoicesDefault
--type-tstringschemas,transform,subsetting,publicKeyschemas,transform,subsetting,publicKey

setup

The snaplet config setup command is used to setup local project configuration.

Usage

snaplet config setup [project-id] [connection-string]

Command Flags

NameTypeDefault
--generatebooleantrue
--yesbooleanfalse

discord

The snaplet discord command is used to opens the Snaplet Discord chat window in your browser.

Usage

snaplet discord

project

The snaplet project command is used to manage project configuration.

Usage

snaplet project [action]

info

The snaplet project info command is used to display information about the project.

Usage

snaplet project info

Command Flags

NameType
--abcstring

invite

The snaplet project invite command is used to create an invite URL for this project.

Usage

snaplet project invite

setup

The snaplet project setup command is used to set up a project.

Usage

snaplet project setup [project-id]

proxy

The snaplet proxy command is used to start a database proxy.

Usage

snaplet proxy

snapshot

The snaplet snapshot command is used to manage snapshots.

Usage

snaplet snapshot [action]

capture

The snaplet snapshot capture command is used to capture a new snapshot.

Usage

snaplet snapshot capture [destination-path]

Command Flags

NameAliasTypeChoicesDefault
--env--environmentstringcloud,locallocal
--message-mstring
--subset--subset-pathstring

create

The snaplet snapshot create command is used to create a snapshot in cloud.

Usage

snaplet snapshot create

Command Flags

NameTypeDefault
--jsonbooleanfalse

list

The snaplet snapshot list command is used to list all snapshots.

Usage

snaplet snapshot list

restore

The snaplet snapshot restore command is used to restore a snapshot.

Usage

snaplet snapshot restore [snapshot-name]

Command Flags

NameAliasDescriptionTypeDeprecatedDefault
--db--db-namestring
--newbooleanfalse
--dataSkip data, only restore schemabooleantrue
--data-onlyRestore data only (keep the current schema and indexes)booleanfalse
--tablesSpecify which tables to restore data for (used with data-only)string
--yes-yPerforms a restore without a confirmation messagebooleanfalse

share

The snaplet snapshot share command is used to Share a snapshot.

Usage

snaplet snapshot share [snapshot-name|snapshot-path]

Command Args

NameDescriptionType
snapshotNamestring

Command Flags

NameAliasDescriptionTypeDefault
--latestThe latest snapshot capturedbooleanfalse
--message-mstring
--no-encryptDisable encryptionbooleanfalse

subset

The snaplet subset command is used to manage subsetting.

Usage

snaplet subset [action]

setup

The snaplet subset setup command is used to configure subsetting.

Usage

snaplet subset setup

team

The snaplet team command is used to manage team configuration.

Usage

snaplet team [action]

create

The snaplet team create command is used to create a new team.

Usage

snaplet team create [name]

upgrade

The snaplet upgrade command is used to upgrade this binary.

Usage

snaplet upgrade

completion

The snaplet completion command is used to generate completion script.

Usage

snaplet completion