DDK

Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

• Define aliases for your project commands (e.g. docker-compose commands)

(back to top)

Built With

• .NET Core 3.1

(back to top)

Getting Started

Prerequisites

All you need to do is install the .NET Core 3.1 Runtime or for developing the tool the .NET Core 3.1 SDK

Installation

NuGet

1. Use NuGet to install the tool globally

   dotnet tool install --global DDK --version 1.0.0

Build it yourself

1. Clone the repo

   git clone https://github.com/Tim-Koertgen/DDK.git

2. Open the project in Visual Studio and press F5 to build

Download a release build

Head over to the releases page to get the latest version of the tool

(back to top)

Usage

The config file needs to be placed in the project / execution directory of the DDK tool.

Example config file

{
  "groups": {
    "docker": {
      "version": {
        "commands": [
          "docker-compose --version",
          "docker --version"
        ],
        "description": "Displays docker-compose and docker version information"
      }
    }
  }
}

Defined commands can be executed by adding the command key name as first parameter (e.g. "version" if you use the example config file).

DDK version

Documentation is in progress

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Tim Körtgen - @SirPhoeniix - [email protected]

Project Link: https://github.com/Tim-Koertgen/DDK

(back to top)