dockscribe

KO | EN

gitlite — search

#ai #llm #golang #rust #deep-learning #linux #java #windows #awesome #kubernetes #vue #mcp #openai #open-source

(★ 23)

CLI that allow to create a visual map for any docker infra

dockscribe Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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.

![gif](https://raw.githubusercontent.com/composecraft/dockscribe/main/gif.gif)

# Get started

## Installation

```bash
pip install dockscribe
```

## Requirements

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

```bash
docker run --rm hello-world
```

[this doc](https://docs.docker.com/engine/install/linux-postinstall/) 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 :

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

```bash
dockscribe login --password mypasword --email my_compose_craft_email
```

Then :

```bash
dockscribe describe
```

![img.png](https://raw.githubusercontent.com/composecraft/dockscribe/main/img.png)

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

```bash
dockscribe describe --filename=./pathToDockerCompose.yaml
```

You can also directly analyse from an url :

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

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

```bash
dockscribe --help
```

dockscribe

dockscribe Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

dockscribe

dockscribe Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README