Skip to content
Sprout

Command Reference

Fast, deduplicated content and database seeding for WordPress

Usage: sprout [OPTIONS] <COMMAND>

Subcommands:
  • init — Initialise a new project and create a sprout.yaml
  • repo — Remote repository commands
  • snap — Create and push new snapshot to your remote repo
  • seed — Seed the database and uploads directory from a remote snapshot
  • un-stash — Restore a locally stashed database and uploads directory
  • stash — Stash your current database and uploads locally (see subcommands to manage your stashes)
  • ls — List available remote snapshots
  • update — Update Sprout to latest release
Options:

  • -p, --path <PATH> — Optional path to your project. Default: current directory

    Default value: ./

  • -j, --json — Output JSON on stdout - useful for CI or piping into other utilities

    Possible values: true, false

sprout init

Initialise a new project and create a sprout.yaml

Usage: sprout init

sprout repo

Remote repository commands

Usage: sprout repo <COMMAND>

Subcommands:
  • new — Create a new repository definition
  • init — Initialise a brand new repository
  • list — List all repository definitions
  • use — Set a default repository used when creating new projects

sprout repo new

Create a new repository definition

Usage: sprout repo new <LABEL>

Arguments:
  • <LABEL> — Your new repository definition label

sprout repo init

Initialise a brand new repository

Usage: sprout repo init [OPTIONS] <LABEL>

Arguments:
  • <LABEL> — Repository definition label to initialise. See the readme for more information on how to connect to S3 or other remote storage providers
Options:
  • -r, --repo-key <REPO_KEY> — Set the repository access key

sprout repo list

List all repository definitions

Usage: sprout repo list

sprout repo use

Set a default repository used when creating new projects

Usage: sprout repo use <LABEL>

Arguments:
  • <LABEL> — Your new repository definition label to use as the default

sprout snap

Create and push new snapshot to your remote repo

Usage: sprout snap [BRANCH]

Arguments:
  • <BRANCH> — Create a snapshot on a specific content branch

sprout seed

Seed the database and uploads directory from a remote snapshot

Usage: sprout seed [OPTIONS] [SNAPSHOT_ID]

Arguments:
  • <SNAPSHOT_ID> — Restore a particular snapshot ID
Options:

  • -n, --no-stash — Do not stash current database and uploads before seeding

    Possible values: true, false

sprout un-stash

Restore a locally stashed database and uploads directory

Usage: sprout un-stash [SNAPSHOT_ID]

Arguments:
  • <SNAPSHOT_ID> — Restore a particular stash snapshot by ID. This will not check project or branch constraints - use with caution

sprout stash

Stash your current database and uploads locally (see subcommands to manage your stashes)

Usage: sprout stash [COMMAND]

Subcommands:
  • list — List all local stashes for the current project
  • drop — Drop a particular stash by snapshot ID

sprout stash list

List all local stashes for the current project

Usage: sprout stash list

sprout stash drop

Drop a particular stash by snapshot ID

Usage: sprout stash drop <SNAPSHOT_ID>

Arguments:
  • <SNAPSHOT_ID> — Drop a particular stash snapshot by ID. This will not check project or branch constraints - use with caution

sprout ls

List available remote snapshots

Usage: sprout ls

sprout update

Update Sprout to latest release

Usage: sprout update

This document was generated automatically by clap-markdown.