# Docker Ready CLI
Docker Ready CLI is a tool for lazy DevOps(and other) engineers.
This tool is definitely for you if:
- you don't like to write configs from scratch;
- you don't have time to review the deployment project documentation;
- you need a ready-to-use project;
- you are lazy and just want everything to work after one command.
## Installation
```shell
$ pipx install docker-ready-cli
```
## Documentation
### Run command
```
$ docker-ready run PROJECT_NAME
```
### Show command
Show all available projects:
```shell
$ docker-ready show
```
Show information about the project by name:
```shell
$ docker-ready show PROJECT_NAME
```
### Ps command
A list of running projects with brief information about their containers.
```shell
$ docker-ready ps
```
A list of running containers for a specific project with detailed information.
```shell
$ docker-ready ps PROJECT_NAME
```
Raw data
{
"_id": null,
"home_page": "https://github.com/docker-ready/cli",
"name": "docker-ready-cli",
"maintainer": "impocode",
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": "impocode@impocode.one",
"keywords": "docker",
"author": "impocode",
"author_email": "impocode@impocode.one",
"download_url": "https://files.pythonhosted.org/packages/58/a8/f8609340613a6c15e8a1c17e3cbe875f280ab7684b171ed0bd4eb350d3a7/docker_ready_cli-0.2.0.tar.gz",
"platform": null,
"description": "# Docker Ready CLI\n\nDocker Ready CLI is a tool for lazy DevOps(and other) engineers.\n\nThis tool is definitely for you if:\n\n- you don't like to write configs from scratch;\n- you don't have time to review the deployment project documentation;\n- you need a ready-to-use project;\n- you are lazy and just want everything to work after one command.\n\n## Installation\n\n```shell\n$ pipx install docker-ready-cli\n```\n\n## Documentation\n\n### Run command\n\n```\n$ docker-ready run PROJECT_NAME\n```\n\n### Show command\n\nShow all available projects:\n\n```shell\n$ docker-ready show\n```\n\nShow information about the project by name:\n\n```shell\n$ docker-ready show PROJECT_NAME\n```\n\n### Ps command\n\nA list of running projects with brief information about their containers.\n\n```shell\n$ docker-ready ps\n```\n\nA list of running containers for a specific project with detailed information.\n\n```shell\n$ docker-ready ps PROJECT_NAME\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": null,
"version": "0.2.0",
"project_urls": {
"Documentation": "https://github.com/docker-ready/cli",
"Homepage": "https://github.com/docker-ready/cli",
"Repository": "https://github.com/docker-ready/cli"
},
"split_keywords": [
"docker"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3e6ae0a86afa1260481586503cf9d394e172fc488af85b459c639294fdfb0e13",
"md5": "8b1f734afa4e4c1f2b7fc0e69205498d",
"sha256": "2414def59a8f5943a6ec7a08f7c57aa58955c6e3d62b2498e552f72cbc11bfab"
},
"downloads": -1,
"filename": "docker_ready_cli-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8b1f734afa4e4c1f2b7fc0e69205498d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 5407,
"upload_time": "2024-06-17T20:17:02",
"upload_time_iso_8601": "2024-06-17T20:17:02.809619Z",
"url": "https://files.pythonhosted.org/packages/3e/6a/e0a86afa1260481586503cf9d394e172fc488af85b459c639294fdfb0e13/docker_ready_cli-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "58a8f8609340613a6c15e8a1c17e3cbe875f280ab7684b171ed0bd4eb350d3a7",
"md5": "a727408702d0c62ab82d29194ffeab2e",
"sha256": "7f97114c59e333f8194039d867b0fbacf2c5b7a4a8579e6a2867f714b35a734f"
},
"downloads": -1,
"filename": "docker_ready_cli-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "a727408702d0c62ab82d29194ffeab2e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 3369,
"upload_time": "2024-06-17T20:17:06",
"upload_time_iso_8601": "2024-06-17T20:17:06.941116Z",
"url": "https://files.pythonhosted.org/packages/58/a8/f8609340613a6c15e8a1c17e3cbe875f280ab7684b171ed0bd4eb350d3a7/docker_ready_cli-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-17 20:17:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "docker-ready",
"github_project": "cli",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "docker-ready-cli"
}
JSON
