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)

$3

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

$3


Aliases: create, up

Description: Launch a database.

Usage:
`bash
create-database --type [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.

---

$3


Aliases: ld, list

Description: List databases.

Usage:
`bash
list-databases
`

---

$3

Description: Get available database types.

Usage:
`bash
get-database-types
`

---

$3


Aliases: delete, rm

Description: Delete database.

Usage:
`bash
delete-database
`

---

$3


Aliases: snapshot

Description: Create a snapshot from an existing database.

Usage:
`bash
create-snapshot [snapshotName]
`

Options:
* -n, --snapshotName: Name of the created snapshot.

---

$3


Aliases: ci

Description: Create image from running database.

Usage:
`bash
create-image [snapshotName]
`

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

---

$3


Aliases: ls

Description: List all snapshots.

Usage:
`bash
list-snapshots
`

---

$3


Aliases: li

Description: List all images.

Usage:
`bash
list-images
`

---

$3


Aliases: rms

Description: Delete snapshot from DevDB.

Usage:
`bash
delete-snapshot
`

---

$3


Aliases: rms

Description: Delete image from DevDB.

Usage:
`bash
delete-image
`

---

$3


Aliases: rb, rollback

Description: Rollback database.

Usage:
`bash
rollback-database [snapshotId]
`

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

---

$3

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 support@devdb.cloud, and we will be happy to help!

(back to top)