Welcome to CinCan Command’s documentation!¶
cincan command provides convenient use of native command-line tools in Docker images. The command is particularly used for security tools packed in the CinCan project. The list of available tools can be found from CinCan’s tool repository. However, it should be usable for most of the other CLI based Docker images.
Our images are currently hosted (as mirrors) in:
Regular usage of Docker images introduces the problem of moving files safely from the host machine into the container. Usually, this is achieved by using volume mounts, but this breaks the concept of isolation, as the host machine is exposed to the container. The
cincan command attempts to avoid usage of volumes while providing a similar command-line experience as using the tool natively.
Some additional features, such as tool version listing and tool command history are provided.
As a prerequisite, you must have
Docker 18.09+ installed for running the tools, and
Python 3.6+ and
pip Python package manager to install the
cincan command is in Python Package Index (PyPi) and can typically be installed by running:
$ pip install cincan-command
See more detailed installation steps in the Installation section.
You can see the list of available tools dockerized in CinCan project with:
$ cincan list
A specific tool can be invoked with
cincan run like this:
cincan run [OPTIONS] TOOL[:TAG] [ARG...]
For example, invoke the tool cincan/pywhois with:
$ cincan run cincan/pywhois 127.0.0.1
Many tools will show you help documentation if you invoke them without arguments, for example:
$ cincan run cincan/tshark
More help is available with options like -h or -–help, depending on the tool.
Note: Make sure
Docker is running when you use the
See more examples in the Commands section.