README.md

Dockscribe

This is a command line tool to produce a visual map of any docker infrastructure from cmd line. This tool require an account on composecraft.com to be used, it's open source for security reason.

Get started

Installation

pip install dockscribe

Requirements

While running the tool, you need to use a user that can call docker cmd like (without sudo):

docker run --rm hello-world

this doc might help you learn how to use docker without sudo.

Usage

The first thing, is to log in to your composecraft.com account ;

Note : You can also use it with your own instance by specifying --url (you will have to specify it for each CLI call)

like :

dockscribe --url https://composecraft.com login --password mypasword --email my_compose_craft_email

dockscribe login --password mypasword --email my_compose_craft_email

Then :

dockscribe describe

This command will produce you a visual map of your current docker infrastructure. You can also view a compose file with :

dockscribe describe --filename=./pathToDockerCompose.yaml

You can also directly analyse from an url :

dockscribe describe --filename=https://yourdockercompose.com/yamlfile.yaml

In case of help, you can call any cmd with --help

dockscribe --help