\n
![](\"https://user-images.githubusercontent.com/316371/28937414-67ee5ffa-7893-11e7-95f9-5059cacf9170.png\")
\n\t\n Immersive terminal interface for managing docker containers, services and images\n
\n\t
\n \n\t
\n Immersive terminal interface for managing docker containers, services and images\n
![\"Console](\"https://console.dev/img/badges/1.0/png/console-badge-pick-green1-dark.png\"){kind=icon}
\n\n\n\n# Install\nInstall the API module as a dependency in your project so you can easily use it to query Operations Orchestration REST API\n\n```javascript\nnpm install -g dockly\n```\n\n# Usage\n\nJust fire up dockly and it will automatically connect to your localhost docker daemon through the unix socket:\n\n```\ndockly\n```\n\n## Command line options:\n\nIt's also possible to provide command line options for dockly to customize the docker connection\n\n| Param | Type | Description |\n| --- | --- | --- |\n| -s or --socketPath | string | Docker socket to connect to |\n| -H or --host | string | Remote docker daemon host to connect to |\n| -P or --port | string | Remote docker port to connect to |\n| -T or --protocol | `http` \\| `https` \\| `ssh` | Remote docker protocol to connect to |\n| --containerFilters | string | String to apply to filter shown containers |\n| -h or --help | null | Display help |\n| -v or --version | null | Display version information |\n\n### `--containerFilters`\n\nThis is a string that could be used to filter the shown containers;\nits 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](https://docs.docker.com/engine/api/v1.37/#operation/ContainerList)\n\nExample: `--containerFilters=\"name=test&status=running\"` to only show *running* container which name match *test*.\n\n# Docker Support\n\n## Run from docker\n\nYou can run dockly using docker:\n\n```\ndocker run -it --rm -v /var/run/docker.sock:/var/run/docker.sock lirantal/dockly\n```\n\n\n## Build\n\nIf you wish to build dockly as a docker image yourself, you can run the following:\n\n```\n$ docker build -t dockly .\n\n$ docker run -it --rm --name dockly -v /var/run/docker.sock:/var/run/docker.sock dockly\n```\n\n# FAQ\n\n1. Unsupported Node.js version\n\nIf you're getting the following error in your CLI:\n```\nroot@neo:~# dockly\n/usr/local/lib/node_modules/dockly/src/screen.js:36\nconstructor (utils = new Map()) {\n^\n\nSyntaxError: Unexpected token =\nat exports.runInThisContext (vm.js:53:16)\nat Module._compile (module.js:374:25)\n```\n\nOr this kind of error:\n```\nTrace: TypeError: Object.values is not a function \n at screen.toggleMode (/home/vokiel/.nvm/versions/node/v6.11.1/lib/node_modules/dockly/src/screen.js:149:35)\n at Screen.screen.key (/home/vokiel/.nvm/versions/node/v6.11.1/lib/node_modules/dockly/src/screen.js:190:12)\n at Screen.EventEmitter._emit\n (/home/vokiel/.nvm/versions/node/v6.11.1/lib/node_modules/dockly/node_modules/blessed/lib/events.js:98:20)\n```\n\nThis is most likely because you're using an unsupported Node.js version.\nDockly requires Node.js v7.6 and above\n\n2. PuTTY displays garbled text\n\nFollow the steps [in this comment](https://github.com/lirantal/dockly/issues/50#issuecomment-536190949) to enable VT100 support on the settings for the window\n\n3. Icons not working properly \n\nset `LANG` and `LC_ALL` to c.UTF-8 like so\n```bash\nexport LANG=C.UTF-8\nexport LC_ALL=C.UTF-8\n```\nfor more info please see [this issue](https://github.com/yaronn/blessed-contrib/issues/111)\n\n## Alternatives\n\nSee [Awesome Docker list](https://github.com/veggiemonk/awesome-docker/blob/master/README.md#terminal) for similar tools to work with Docker.\n\n# In the news\n\n- Admin Magazine article: [Visualizing containers with clarity\n](https://www.admin-magazine.com/Articles/Visualizing-containers-with-clarity)\n- [A learnk8s tweet](https://twitter.com/learnk8s/status/1075677503782563840)\n- [Dockly – Manage Docker Containers From Terminal](https://ostechnix.com/dockly-manage-docker-containers-from-terminal/)\n- [Clever cloud CEO, Quentin Adam, tweeting about dockly](https://twitter.com/waxzce/status/1123886351924043777)\n\n# Author\nLiran Tal \n \n ![\"Node.js](\"https://img.shields.io/badge/%F0%9F%A6%84-Learn%20Node.js%20Security%E2%86%92-gray.svg?colorA=5734F5&colorB=5734F5&style=flat\"){kind=icon}
\n \n
\n Learn Node.js Secure Coding techniques and best practices from Liran Tal\n
\n