Skip to content

adeotek/dot

Repository files navigation

dot - AdeoTEK DevOps Tools

dot is a collection of CLI tools for developers and DevOps.

Supported versions: .NET 8+

.NET build

Install

AdeoTEK DevOps Tools NuGet package can be found on nuget.org.

# Install latest version (preview version are not included)
dotnet tool install --global AdeoTEK.DevOpsTools

# Install specific version
dotnet tool install --global Adeotek.DevOpsTools --version <specific_version>

Update

dotnet tool update -g AdeoTEK.DevOpsTools

Usage

dot <command> <subcommand> [arguments] [options]
# or
dotnet dot <command> <subcommand> [arguments] [options]

To get more information about a command, run:

dot <command> --help
# or
dot <command> <subcommand> --help

Commands

containers/container

Docker/Podman containers management tool. The subcommand work in a similar way to docker-compose, but with the ability to target individual services (containers). The subcommands allows for containers manipulation based on configuration files written in YAML or JSON. The configuration file structure is compatible with docker-compose configuration files with a few small caveats (see ContainersConfiguration.md).

Subcommands

  • up - Create/Update Docker/Podman containers based on YAML/JSON configuration files
  • down - Remove Docker/Podman containers based on YAML/JSON configuration files
  • backup - Backup Docker/Podman containers volumes based on YAML/JSON configuration files
  • start - Start Docker/Podman containers based on YAML/JSON configuration files
  • stop - Stop Docker/Podman containers based on YAML/JSON configuration files
  • restart - Restart Docker/Podman containers based on YAML/JSON configuration files
  • config - YAML/JSON configuration files generator/checker
    • validate - Validate existing YAML/JSON configuration file
    • sample - Generate new sample YAML/JSON configuration file

Check ContainersConfiguration.md for more information about the configuration files.

email

Email tools.

Subcommands

  • send - Send an email message based on a configuration file or provided options

Check EmailConfiguration.md for more information about the configuration files.

port

TCP Ports tools.

Subcommands

  • listen - Start a listener on the provided TCP port
  • probe - Probe (check if listening) a local or remote TCP port

utf8bom

This tool allows for adding/removing/checking the BOM (Byte Order Mark) signature of UTF-8 encoded files.

Subcommands

  • add - Add BOM (Byte Order Mark) to any UTF-8 files that do not have it
  • remove - Remove BOM (Byte Order Mark) from any UTF-8 files that have it

To only check if BOM is present, without changing it, use the add/remove subcommands together with the --dry-run option.