3.21.4 • Public • Published

    Immersive terminal interface for managing docker containers, services and images

    Node Version view on npm view on npm npm module downloads Known Vulnerabilities Security Responsible Disclosure dockly

    🌟 Featured on Awesome Docker DevOps Weekly terminals are sexy



    Install the API module as a dependency in your project so you can easily use it to query Operations Orchestration REST API

    npm install -g dockly


    Just fire up dockly and it will automatically connect to your localhost docker daemon through the unix socket:


    Command line options:

    It's also possible to provide command line options for dockly to customize the docker connection

    Param Type Description
    -s or --socketPath string Docker socket to connect to
    --containerFilters string String to apply to filter shown containers
    -h or --help null Display help
    -v or --version null Display version information


    This is a string that could be used to filter the shown containers; its format is in the x-www-form-urlencoded style and the filters you could apply are listed here:

    Example: --containerFilters="name=test&status=running" to only show running container which name match test.

    Docker Support

    Run from docker

    You can run dockly using docker:

    docker run -it --rm -v /var/run/docker.sock:/var/run/docker.sock lirantal/dockly


    If you wish to build dockly as a docker image yourself, you can run the following:

    $ docker build -t dockly .
    $ docker run -it --rm --name dockly -v /var/run/docker.sock:/var/run/docker.sock dockly


    1. Unsupported Node.js version

    If you're getting the following error in your CLI:

    root@neo:~# dockly
    constructor (utils = new Map()) {
    SyntaxError: Unexpected token =
    at exports.runInThisContext (vm.js:53:16)
    at Module._compile (module.js:374:25)

    Or this kind of error:

    Trace: TypeError: Object.values is not a function                                                                                                            
        at screen.toggleMode (/home/vokiel/.nvm/versions/node/v6.11.1/lib/node_modules/dockly/src/screen.js:149:35)
        at Screen.screen.key (/home/vokiel/.nvm/versions/node/v6.11.1/lib/node_modules/dockly/src/screen.js:190:12)
        at Screen.EventEmitter._emit

    This is most likely because you're using an unsupported Node.js version. Dockly requires Node.js v7.6 and above

    1. PuTTY displays garbled text

    Follow the steps in this comment to enable VT100 support on the settings for the window

    1. Icons not working properly

    set LANG and LC_ALL to c.UTF-8 like so

    export LANG=C.UTF-8
    export LC_ALL=C.UTF-8

    for more info please see this issue


    Liran Tal


    See Awesome Docker list for similar tools to work with Docker.


    npm i dockly

    DownloadsWeekly Downloads






    Unpacked Size

    83.5 kB

    Total Files


    Last publish


    • avatar
    • avatar