{"id":50357650,"url":"https://github.com/rorylshanks/devdb-client","last_synced_at":"2026-05-29T23:12:22.452Z","repository":{"id":57685812,"uuid":"489922931","full_name":"rorylshanks/devdb-client","owner":"rorylshanks","description":"This is the repository for the official command line client for DevDB (https://devdb.cloud)","archived":false,"fork":false,"pushed_at":"2025-03-09T16:20:14.000Z","size":1329,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-09T04:35:59.929Z","etag":null,"topics":["cloud","data","database-management","development"],"latest_commit_sha":null,"homepage":"https://devdb.cloud","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rorylshanks.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-08T11:23:05.000Z","updated_at":"2025-03-09T16:20:17.000Z","dependencies_parsed_at":"2025-03-09T17:21:35.638Z","dependency_job_id":"0c124458-349d-4f17-aec5-37197f463e75","html_url":"https://github.com/rorylshanks/devdb-client","commit_stats":null,"previous_names":["rorylshanks/devdb-client","megalan247/devdb-client"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rorylshanks/devdb-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rorylshanks%2Fdevdb-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rorylshanks%2Fdevdb-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rorylshanks%2Fdevdb-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rorylshanks%2Fdevdb-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rorylshanks","download_url":"https://codeload.github.com/rorylshanks/devdb-client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rorylshanks%2Fdevdb-client/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33674267,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-29T02:00:06.066Z","response_time":107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cloud","data","database-management","development"],"created_at":"2026-05-29T23:12:21.610Z","updated_at":"2026-05-29T23:12:22.431Z","avatar_url":"https://github.com/rorylshanks.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- Improved compatibility of back to top link: See: https://github.com/othneildrew/Best-README-Template/pull/73 --\u003e\n\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/rorylshanks/devdb-client\"\u003e\n    \u003cimg src=\"https://devdb.cloud/images/logo.png\" alt=\"Logo\" width=\"220\" height=\"80\"\u003e\n  \u003c/a\u003e\n\n\u003ch3 align=\"center\"\u003eDevDB Command Line Client\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    A CLI client for accessing and automating DevDB\n    \u003cbr /\u003e\n    \u003ca href=\"https://docs.devdb.cloud/\"\u003e\u003cstrong\u003eExplore the docs »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://devdb.cloud/\"\u003eView Demo\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/rorylshanks/devdb-client/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/rorylshanks/devdb-client/issues\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\n![DevDB CLI Screenshot](./images/demo.gif)\n\nThis 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.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n### Installation\n\n1. Get an API key from your account at https://devdb.cloud/\n2. Install the command line client with NPM  \n    ```\n    sudo npm i -g devdb-cli@latest\n    ```\n3. Export the DEVDB_API_KEY environment variable  \n    ```\n    export DEVDB_API_KEY=ENTER_API_KEY_HERE\n    ```\n4. Start creating databases!\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- USAGE EXAMPLES --\u003e\n## Usage\n\n# DevDB CLI Documentation\n\nThe DevDB CLI provides several useful commands to manage your DevDB databases, snapshots, and images.\n\n## Commands\n\n### create-database\n**Aliases**: `create`, `up`\n\n**Description**: Launch a database.\n\n**Usage**: \n```bash\ncreate-database --type \u003cdatabaseType\u003e [options]\n```\n\n**Options**:\n* `-t, --type`: The type of database you want to create in DevDB. This option is required.\n* `-n, --name`: Name of the created database.\n* `-i, --image`: Image to create the database from.\n* `-p, --proxy`: Start DevDB client in proxy mode (requires socat to be installed, unless running in Docker).\n* `--proxyPort`: Local port to listen on for proxy mode.\n* `--username`: Desired username to use for the database. When unset a random username will be generated.\n* `--password`: Desired password to use for the database. When unset a random password will be generated.\n* `--reconnect`: Reconnect to the database with the specified name, if it exists. If it doesn't exist, it will create normally.\n\n---\n\n### list-databases\n**Aliases**: `ld`, `list`\n\n**Description**: List databases.\n\n**Usage**: \n```bash\nlist-databases\n```\n\n---\n\n### get-database-types\n\n**Description**: Get available database types.\n\n**Usage**: \n```bash\nget-database-types\n```\n\n---\n\n### delete-database\n**Aliases**: `delete`, `rm`\n\n**Description**: Delete database.\n\n**Usage**: \n```bash\ndelete-database \u003cdatabaseId\u003e\n```\n\n---\n\n### create-snapshot\n**Aliases**: `snapshot`\n\n**Description**: Create a snapshot from an existing database.\n\n**Usage**: \n```bash\ncreate-snapshot \u003cdatabaseId\u003e [snapshotName]\n```\n\n**Options**:\n* `-n, --snapshotName`: Name of the created snapshot.\n\n---\n\n### create-image\n**Aliases**: `ci`\n\n**Description**: Create image from running database.\n\n**Usage**: \n```bash\ncreate-image \u003cdatabaseId\u003e [snapshotName]\n```\n\n**Options**:\n* `-n, --snapshotName`: Name of the created image. This option is required.\n\n---\n\n### list-snapshots\n**Aliases**: `ls`\n\n**Description**: List all snapshots.\n\n**Usage**: \n```bash\nlist-snapshots \u003cdatabaseId\u003e\n```\n\n---\n\n### list-images\n**Aliases**: `li`\n\n**Description**: List all images.\n\n**Usage**: \n```bash\nlist-images\n```\n\n---\n\n### delete-snapshot\n**Aliases**: `rms`\n\n**Description**: Delete snapshot from DevDB.\n\n**Usage**: \n```bash\ndelete-snapshot \u003csnapshotId\u003e\n```\n\n---\n\n### delete-image\n**Aliases**: `rms`\n\n**Description**: Delete image from DevDB.\n\n**Usage**: \n```bash\ndelete-image \u003cimageId\u003e\n```\n\n---\n\n### rollback-database\n**Aliases**: `rb`, `rollback`\n\n**Description**: Rollback database.\n\n**Usage**: \n```bash\nrollback-database \u003cdatabaseId\u003e [snapshotId]\n```\n\n**Options**:\n* `--snapshotId, --snapshot`: ID of the snapshot to rollback to. Defaults to the most recent snapshot.\n\n---\n\n### Global options\n\n**Options**:\n* `-k, --apikey`: API Key to access DevDB (or from env var DEVDB_API_KEY).\n* `--manifest`: Write a JSON output manifest file with the detailed results of the requested command.\n\n---\n\nTo get help for any command, you can use the `--help` flag after the command.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the Mozilla Public License Version 2.0. See `LICENSE.md` for more information.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- CONTACT --\u003e\n## Contact\n\nPlease let us know of any issues with this at support@devdb.cloud, and we will be happy to help!\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frorylshanks%2Fdevdb-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frorylshanks%2Fdevdb-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frorylshanks%2Fdevdb-client/lists"}