docky_cli.commands package

Docky commands.

Submodules

docky_cli.commands.down module

Remove Docker dependencies management command.

docky_cli.commands.down.down() → None

Remove all Containers, Networks, Images and Volumes in compose file.

Reads project’s compose file, and removes all of it’s dependencies from host machine.

docky_cli.commands.down.remove_dependencies() → None

Remove all Containers, Networks, Images and Volumes in compose file.

docky_cli.commands.env_file module

.env file management command.

docky_cli.commands.env_file.create_env_file() → None

Create .env file in project’s root, if it does not already exists.

docky_cli.commands.env_file.env(show: bool = False) → None

Create .env file in project’s root, if it does not already exists.

Parameters

show (bool) – Show variables in .env file, by default False

docky_cli.commands.env_file.read_env_file() → Dict[str, str]

Read variables in .env file.

Returns

Dict with keys being .env file’s variable names and values being it’s values.

Return type

Dict[str, str]

docky_cli.commands.lint module

Lint Dockerfile using hadolint https://github.com/hadolint/hadolint.

docky_cli.commands.lint.lint() → None

Lint Dockerfile.

docky_cli.commands.list_docker_objects module

List all Docker objects management command.

docky_cli.commands.list_docker_objects.list_docker_objects(show_all: bool = False) → None

List all Containers, Networks, Images and Volumes in compose file.

Parameters

show_all (bool) – List all Containers, Networks, Images and Volumes in host machine , by default False

docky_cli.commands.run module

Run commands in Docker’s Container.

docky_cli.commands.run.run(command: List[Optional[str]]) → None

Run service’s Container default command or run a custom command in it.

If images are not yet built, they are build before running the command.

If no command is passed, runs the Container’s default command. Otherwise, runs the passed commands in the Container and exits.

Parameters

command (List[Optional[str]]) – Command to run instead of Container’s default command.

docky_cli.commands.run.run_command_in_container(command: List[Optional[str]]) → None

Run service’s Container default command or run a custom command in it.

Parameters

command (List[Optional[str]]) – Command to run instead of Container’s default command.

docky_cli.commands.scan module

Security vulnerability scan for Image using SNYK https://snyk.io/.

docky_cli.commands.scan.scan() → None

Scan service’s Image for security vulnerabilities.

You need to have an account in https://snyk.io/ to execute the scan.

docky_cli.commands.scan.scan_image() → None

Scan service’s Image for security vulnerabilities.

docky_cli.commands.up module

Start application with Docker’s Containers.

docky_cli.commands.up.start_all() → None

Start all services in compose file.