Skip to content

Commit be657ef

Browse files
authored
Enhance documentation in docker-manager.sh
Added detailed usage instructions and options for the script.
1 parent 7b9c462 commit be657ef

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

docker-manager.sh

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,35 @@
11
#!/bin/bash
22

3-
# docker-manager.sh - A professional Docker management script
3+
#===============================================================================
4+
#
5+
# FILE: docker-manager.sh
6+
#
7+
# USAGE: ./docker-manager.sh <command> [--env-file <path>]
8+
#
9+
# DESCRIPTION: A professional Bash script for managing Docker projects.
10+
# Supports Docker login, build, pull, push, and Docker Compose
11+
# operations with an easy-to-use interface.
12+
#
13+
# OPTIONS:
14+
# init - Initialize Docker username and project name
15+
# login - Log in to Docker registry
16+
# pull - Pull Docker image
17+
# push - Push Docker image
18+
# build - Build Docker image
19+
# create - Start containers (Docker Compose)
20+
# close - Stop containers (Docker Compose)
21+
# recreate - Restart containers (close + create)
22+
# start - Start stopped containers
23+
# stop - Stop running containers
24+
# help - Display this help message
25+
#
26+
# REQUIREMENTS: bash, docker, docker-compose, jq
27+
# AUTHOR: Matéo Florian Callec
28+
# LICENSE: MIT
29+
# REPO: https://github.com/mateocallec/docker-manager.sh
30+
#
31+
#===============================================================================
32+
433

534
# Set the project directory
635
PROJECT_DIR=$(pwd)

0 commit comments

Comments
 (0)