0.0.1 • Published 6 months ago

docker-my-app v0.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

docker-my-app

Dockerize any software project with just a few clicks.

Command Line Interface for developers to dockerize their app using ChatGPT.

Installation

Run

$ npm install -g docker-my-app

How to get OpenAI API Key?

Go to OpenAI's Platform website at OpenAI and sign in with an OpenAI account. Click your profile icon at the top-right corner of the page and select "View API Keys." Click "Create New Secret Key" to generate a new API key

Usage

  • First, set the api key by typing docker-my-app config in the terminal.

  • Go to the project directory and run any of the below commands.

Commands available

docker-my-app <command>

Commands:
  docker-my-app config                  [Change configuration and defaults]

  docker-my-app docker-compose.yml      [Generate docker-compose.yml file]

  docker-my-app dockerfile              [Generate Dockerfile for your project]
  
  docker-my-app dockerignore            [Generate .dockerignore File]

Options:
  -h, --help     Show help                                             [boolean]
      --version  Show version number                                   [boolean]

Command dockerfile

Generate Dockerfile for your project.

Usage: docker-my-app dockerfile

Options:
  -h, --help     Show help                                             [boolean]
      --version  Show version number                                   [boolean]

Examples:
  docker-my-app dockerfile

Command docker-compose.yml

Generate docker-compose.yml file for your project.

Usage: docker-my-app docker-compose.yml

Options:
  -h, --help     Show help                                             [boolean]
      --version  Show version number                                   [boolean]

Examples:
  docker-my-app docker-compose.yml

Command dockerignore

Generate .dockerignore file for your project.

Usage: docker-my-app dockerignore

Options:
  -h, --help     Show help                                             [boolean]
      --version  Show version number                                   [boolean]

Examples:
  docker-my-app dockerignore

Command config

Change configuration and defaults. (Set OpenAI API Key)

Usage: docker-my-app config

Options:
  -h, --help     Show help                                             [boolean]
      --version  Show version number                                   [boolean]

Examples:
  docker-my-app config
  

Development

Run:

$ git clone https://github.com/karanjagota/docker-my-app.git
$ cd docker-my-app
$ npm link

This will setup a symbolic link to the CLI. Any changes in source files will now be reflected when running the docker-my-app command.

Get in touch

Send me a message on twitter to know more about me or have a conversation. Share this is project by clicking the link share

License

MIT License

Copyright (c) 2023 karan jagota

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.