Skip to content

Latest commit

 

History

History
237 lines (159 loc) · 4.94 KB

README.md

File metadata and controls

237 lines (159 loc) · 4.94 KB
Raw

Logo

DevDB Command Line Client

A CLI client for accessing and automating DevDB
Explore the docs »

View Demo · Report Bug · Request Feature

About The Project

DevDB CLI Screenshot

This is the CLI component for DevDB - a developer-focused database management platform. With DevDB you can quickly create databases for development and testing purposes, without the complexity of maintaining shared databases or Docker images.

(back to top)

Installation

  1. Get an API key from your account at https://devdb.cloud/
  2. Install the command line client with NPM 
    sudo npm i -g devdb-cli@latest
  3. Export the DEVDB_API_KEY environment variable 
    export DEVDB_API_KEY=ENTER_API_KEY_HERE
  4. Start creating databases!

(back to top)

Usage

DevDB CLI Documentation

The DevDB CLI provides several useful commands to manage your DevDB databases, snapshots, and images.

Commands

create-database

Aliases: create, up

Description: Launch a database.

Usage:

create-database --type <databaseType> [options]

Options:

  • -t, --type: The type of database you want to create in DevDB. This option is required.
  • -n, --name: Name of the created database.
  • -i, --image: Image to create the database from.
  • -p, --proxy: Start DevDB client in proxy mode (requires socat to be installed, unless running in Docker).
  • --proxyPort: Local port to listen on for proxy mode.
  • --username: Desired username to use for the database. When unset a random username will be generated.
  • --password: Desired password to use for the database. When unset a random password will be generated.
  • --reconnect: Reconnect to the database with the specified name, if it exists. If it doesn't exist, it will create normally.

list-databases

Aliases: ld, list

Description: List databases.

Usage:

list-databases

get-database-types

Description: Get available database types.

Usage:

get-database-types

delete-database

Aliases: delete, rm

Description: Delete database.

Usage:

delete-database <databaseId>

create-snapshot

Aliases: snapshot

Description: Create a snapshot from an existing database.

Usage:

create-snapshot <databaseId> [snapshotName]

Options:

  • -n, --snapshotName: Name of the created snapshot.

create-image

Aliases: ci

Description: Create image from running database.

Usage:

create-image <databaseId> [snapshotName]

Options:

  • -n, --snapshotName: Name of the created image. This option is required.

list-snapshots

Aliases: ls

Description: List all snapshots.

Usage:

list-snapshots <databaseId>

list-images

Aliases: li

Description: List all images.

Usage:

list-images

delete-snapshot

Aliases: rms

Description: Delete snapshot from DevDB.

Usage:

delete-snapshot <snapshotId>

delete-image

Aliases: rms

Description: Delete image from DevDB.

Usage:

delete-image <imageId>

rollback-database

Aliases: rb, rollback

Description: Rollback database.

Usage:

rollback-database <databaseId> [snapshotId]

Options:

  • --snapshotId, --snapshot: ID of the snapshot to rollback to. Defaults to the most recent snapshot.

Global options

Options:

  • -k, --apikey: API Key to access DevDB (or from env var DEVDB_API_KEY).
  • --manifest: Write a JSON output manifest file with the detailed results of the requested command.

To get help for any command, you can use the --help flag after the command.

(back to top)

License

Distributed under the Mozilla Public License Version 2.0. See LICENSE.md for more information.

(back to top)

Contact

Please let us know of any issues with this at [email protected], and we will be happy to help!

(back to top)