dockly

Immersive terminal interface for managing docker containers and services

Github stars Tracking Chart

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

? Featured on Awesome Docker DevOps Weekly
terminals are sexy

dockly-demo-2

Install

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

Usage

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

dockly

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, ### --containerFilters

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: https://docs.docker.com/engine/api/v1.37/#operation/ContainerList

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

Build

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

FAQ

  1. Unsupported Node.js version

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

root@neo:~# dockly
/usr/local/lib/node_modules/dockly/src/screen.js:36
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
    (/home/vokiel/.nvm/versions/node/v6.11.1/lib/node_modules/dockly/node_modules/blessed/lib/events.js:98:20)

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

Author

Liran Tal liran.tal@gmail.com

Main metrics

Overview
Name With Ownerlirantal/dockly
Primary LanguageJavaScript
Program languageJavaScript (Language Count: 3)
Platform
License:MIT License
所有者活动
Created At2016-10-22 21:47:48
Pushed At2025-06-26 12:54:40
Last Commit At
Release Count68
Last Release Namev3.24.5 (Posted on )
First Release Namev2.1.0 (Posted on 2017-05-27 20:09:28)
用户参与
Stargazers Count3.9k
Watchers Count43
Fork Count161
Commits Count309
Has Issues Enabled
Issues Count83
Issue Open Count3
Pull Requests Count136
Pull Requests Open Count4
Pull Requests Close Count83
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private