🌜
ğŸŒž
dockly

dockly

v3.21.4

Immersive terminal interface for managing docker containers and services

npm install dockly

README



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

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:

[email protected]:~# 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

  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

Author

Liran Tal [email protected]

Alternatives

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

Release Notes

3.21.4
Published on July 1, 2021

3.21.4 (2021-07-01)

Bug Fixes

  • dockly crash when copy to Clipboard fails (#178) (b192839)
3.21.3
Published on July 1, 2021

3.21.3 (2021-07-01)

Bug Fixes

3.21.2
Published on June 24, 2021

3.21.2 (2021-06-24)

Bug Fixes

  • enforce correct fonts/locales setup in docker (#169) (f0c1c73)
3.21.1
Published on June 24, 2021

3.21.1 (2021-06-24)

Bug Fixes

  • build image based on pinned deps in the project (#170) (f85fb02)
3.21.0
Published on June 24, 2021

3.21.0 (2021-06-24)

Features

  • copy id lable changes depended on view (#168) (d9eb9c5)
3.20.1
Published on June 19, 2021

3.20.1 (2021-06-19)

Bug Fixes

  • package.json & yarn.lock to reduce vulnerabilities (#166) (7b5d28a)
3.20.0
Published on June 19, 2021

3.20.0 (2021-06-19)

Features

3.19.0
Published on June 18, 2021

3.19.0 (2021-06-18)

Features

3.18.3
Published on June 18, 2021

3.18.3 (2021-06-18)

Bug Fixes

3.18.2
Published on May 12, 2021

3.18.2 (2021-05-12)

Bug Fixes

General

License
MIT
Typescript Types
None found
Tree-shakeable
No

Popularity

GitHub Stargazers
3,356
Community Interest
3,217
Number of Forks
154

Maintenance

Commits
10/219/2207
Last Commit
Open Issues
5
Closed Issues
67
Open Pull Requests
13
Closed Pull Requests
21

Versions

Versions Released
10/219/2201
Latest Version Released
Jul 1, 2021
Current Tags
latest3.21.4

Contributors

lirantal
lirantal
Commits: 178
snyk-bot
snyk-bot
Commits: 14
OmriBarZik
OmriBarZik
Commits: 14
kadenlnelson
kadenlnelson
Commits: 3
MatanAvneri
MatanAvneri
Commits: 3
israelroldan
israelroldan
Commits: 2
sebastian-curland
sebastian-curland
Commits: 2
styfle
styfle
Commits: 2
Jamesking56
Jamesking56
Commits: 1
bieron
bieron
Commits: 1
JimCodified
JimCodified
Commits: 1
hoegge
hoegge
Commits: 1
norweeg
norweeg
Commits: 1
trevdor
trevdor
Commits: 1
robhowell
robhowell
Commits: 1