{"_id":"@amazing-kit/docker","_rev":"6-c31e6c448dda0b76183bad40a4f440a8","name":"@amazing-kit/docker","dist-tags":{"latest":"1.0.6"},"versions":{"1.0.0":{"name":"@amazing-kit/docker","version":"1.0.0","description":"```ts import docker from \"@amazing-kit/docker\"","main":"dist/index.js","scripts":{"test":"vitest run","test:watch":"vitest watch","build":"vite build","build:watch":"vite build --watch","clean":"rimraf dist .turbo node_modules","prepublishOnly":"zx bin/prepublish.mjs"},"keywords":[],"author":"","license":"ISC","devDependencies":{"@types/node":"^20.6.0","npm-run-all":"^4.1.5","rimraf":"^5.0.1","typescript":"^5.2.2","vite":"^4.4.9","vitest":"^0.34.4"},"dependencies":{"zx":"^7.2.3"},"publishConfig":{"access":"public"},"gitHead":"bd522e39b7514212c37084b5fdebe0d84a61ddcb","_id":"@amazing-kit/docker@1.0.0","_nodeVersion":"20.2.0","_npmVersion":"9.6.6","dist":{"integrity":"sha512-Btf/54A4DBB0e14FfbNKNPnt6myTNdbLXyWP5HpacpKRjVluGnw9gNBpyELc6cbFhDp0ObGe1CLV94YcRFnv1A==","shasum":"6311d1172bb6d02daa5516362e6809a1f2a3c0e4","tarball":"https://registry.npmjs.org/@amazing-kit/docker/-/docker-1.0.0.tgz","fileCount":7,"unpackedSize":26977,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIGbSvdWtgHV+ty0pzF7EmUbeArrNym38RrNaVkJRPxTJAiAQK8k159yZsddVwpWnnVeYDHjgnUaNK7tqY8oUwM0+QA=="}]},"_npmUser":{"name":"wooandoo","email":"frederic.mascaro@gmail.com"},"directories":{},"maintainers":[{"name":"wooandoo","email":"frederic.mascaro@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/docker_1.0.0_1694589947542_0.5731519547019717"},"_hasShrinkwrap":false},"1.0.1":{"name":"@amazing-kit/docker","version":"1.0.1","description":"```ts import docker from \"@amazing-kit/docker\"","main":"dist/index.js","scripts":{"test":"vitest run","test:watch":"vitest watch","build":"vite build","build:watch":"vite build --watch","clean":"rimraf dist .turbo node_modules","prepublishOnly":"zx bin/prepublish.mjs"},"keywords":[],"author":"","license":"MIT","devDependencies":{"@types/node":"^20.6.0","npm-run-all":"^4.1.5","rimraf":"^5.0.1","typescript":"^5.2.2","vite":"^4.4.9","vitest":"^0.34.4"},"dependencies":{"zx":"^7.2.3"},"publishConfig":{"access":"public"},"gitHead":"3d0a98e633159452e34ce132fe90cbe178eb0818","_id":"@amazing-kit/docker@1.0.1","_nodeVersion":"20.2.0","_npmVersion":"9.6.6","dist":{"integrity":"sha512-XoLv4GJlh2850R601aaDA1oyoJkWt9fn7xrlLKD15qOZPIpb8TqTQpeLs5Tf6jwSJHCmz3vU5LWFwCMM77d36A==","shasum":"6f6b8bbf91fff5952b8cee6e757d207c6b7c0c14","tarball":"https://registry.npmjs.org/@amazing-kit/docker/-/docker-1.0.1.tgz","fileCount":7,"unpackedSize":7067,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFr3PijN6h2fS/X7UMwZIcCuVC1/Ess2ibkwDLRRwhcdAiAY6bgNE7o1LpuY46lhDkfqSzvbnt1CMJJMWCi0CqyECA=="}]},"_npmUser":{"name":"wooandoo","email":"frederic.mascaro@gmail.com"},"directories":{},"maintainers":[{"name":"wooandoo","email":"frederic.mascaro@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/docker_1.0.1_1694590944255_0.07778515539081443"},"_hasShrinkwrap":false},"1.0.2":{"name":"@amazing-kit/docker","version":"1.0.2","description":"```ts import docker from \"@amazing-kit/docker\"","main":"dist/index.js","module":"dist/index.mjs.js","types":"dist/index.d.ts","scripts":{"test":"vitest run","test:watch":"vitest watch","build":"run-p build:source build:types","build:source":"vite build","build:types":"tsc --emitDeclarationOnly","build:watch":"vite build --watch","clean":"rimraf dist .turbo node_modules","prepublishOnly":"zx bin/prepublish.mjs"},"keywords":[],"author":"","license":"MIT","devDependencies":{"@types/node":"^20.6.0","npm-run-all":"^4.1.5","rimraf":"^5.0.1","typescript":"^5.2.2","vite":"^4.4.9","vitest":"^0.34.4"},"dependencies":{"zx":"^7.2.3"},"publishConfig":{"access":"public"},"gitHead":"1a78fc5e8c491014eaca5f0d21eef889fd9e61b5","_id":"@amazing-kit/docker@1.0.2","_nodeVersion":"20.2.0","_npmVersion":"9.6.6","dist":{"integrity":"sha512-W6qPoYMUZvoeo6v6lpRIlMuDEQ0JZ1cvT4YhPZghpQAg8t/1NFWHCiM0wJRvA0lm04GSimwfh2rRv4hh//bbFQ==","shasum":"9e5afd4ba27be839b398a0dfbb7f76652075a977","tarball":"https://registry.npmjs.org/@amazing-kit/docker/-/docker-1.0.2.tgz","fileCount":13,"unpackedSize":11141,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCUl6DX+nOnXMEFX0sijpKiTMMJDj6VPDyXRDbQByR71AIhALw8UpCjRAG1/s29SdZIPKSWjvWiCqfTQjeGPnP9ve24"}]},"_npmUser":{"name":"wooandoo","email":"frederic.mascaro@gmail.com"},"directories":{},"maintainers":[{"name":"wooandoo","email":"frederic.mascaro@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/docker_1.0.2_1694592854844_0.08873350218169085"},"_hasShrinkwrap":false},"1.0.3":{"name":"@amazing-kit/docker","version":"1.0.3","description":"```ts import docker from \"@amazing-kit/docker\"","main":"dist/index.js","module":"dist/index.mjs.js","types":"dist/index.d.ts","scripts":{"test":"vitest run","test:watch":"vitest watch","build":"run-p build:source build:types","build:source":"vite build","build:types":"tsc --emitDeclarationOnly","build:watch":"vite build --watch","clean":"rimraf dist .turbo node_modules","prepublishOnly":"zx bin/prepublish.mjs"},"keywords":[],"author":"","license":"MIT","devDependencies":{"@types/node":"^20.6.0","npm-run-all":"^4.1.5","rimraf":"^5.0.1","typescript":"^5.2.2","vite":"^4.4.9","vitest":"^0.34.4"},"dependencies":{"zx":"^7.2.3"},"exports":{".":{"import":"./dist/index.mjs.js","require":"./dist/index.js"}},"publishConfig":{"access":"public"},"gitHead":"c223a160876dab04a287960527575cf67b10a92a","_id":"@amazing-kit/docker@1.0.3","_nodeVersion":"20.2.0","_npmVersion":"9.6.6","dist":{"integrity":"sha512-FxG7mV1Gv23DuTAZfVjHETkzu6lX4q+tlXFt5A/YhYRIE0WBecrk8XJo8sE0KItTAximV2pjdmreXvx8TnoScg==","shasum":"b52da3df27c859bf70f56e0130e391f3c3d9161e","tarball":"https://registry.npmjs.org/@amazing-kit/docker/-/docker-1.0.3.tgz","fileCount":13,"unpackedSize":11363,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCwkPWDsXhLIO2NkeF5da8MCcjSqRL2Wq+lg120GCAOqAIhAJdlrcWFTxAvGXxhOAeSKgL4V3tbWUAGhC6YikpICVn5"}]},"_npmUser":{"name":"wooandoo","email":"frederic.mascaro@gmail.com"},"directories":{},"maintainers":[{"name":"wooandoo","email":"frederic.mascaro@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/docker_1.0.3_1694593939927_0.386078911061964"},"_hasShrinkwrap":false},"1.0.4":{"name":"@amazing-kit/docker","version":"1.0.4","description":"Run docker commands in node.js (not all commands are supported yet)","main":"dist/index.js","type":"module","types":"dist/index.d.ts","scripts":{"test":"vitest run","test:watch":"vitest watch","build":"run-p build:source build:types","build:source":"vite build","build:types":"tsc --emitDeclarationOnly","build:watch":"vite build --watch","clean":"rimraf dist .turbo node_modules","prepublishOnly":"zx bin/prepublish.mjs"},"keywords":[],"author":"","license":"MIT","devDependencies":{"@types/node":"^20.6.0","npm-run-all":"^4.1.5","rimraf":"^5.0.1","typescript":"^5.2.2","vite":"^4.4.9","vitest":"^0.34.4"},"dependencies":{"zx":"^7.2.3"},"exports":{".":{"import":"./dist/index.mjs.js","require":"./dist/index.js"}},"publishConfig":{"access":"public"},"gitHead":"c223a160876dab04a287960527575cf67b10a92a","_id":"@amazing-kit/docker@1.0.4","_nodeVersion":"20.2.0","_npmVersion":"9.6.6","dist":{"integrity":"sha512-yiBij7Uu1d1bM+twvH06zHN5Zog6hCWvGUeNyVgMEr9FY1vJFbmHJ7/RivZekIlhonCtv0P34RkIlLFzTnK8lg==","shasum":"0eb1c2019f4dd60cb2967797d6e0d62341a58a85","tarball":"https://registry.npmjs.org/@amazing-kit/docker/-/docker-1.0.4.tgz","fileCount":12,"unpackedSize":9277,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCUUKPpNEQdXSY6f8AQpAweSgDnXYUgpg2lx53fRtRu+wIgRZgNud4OQDRFjUKNS4EWAtnknJ4754J84hA5Mokd86c="}]},"_npmUser":{"name":"wooandoo","email":"frederic.mascaro@gmail.com"},"directories":{},"maintainers":[{"name":"wooandoo","email":"frederic.mascaro@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/docker_1.0.4_1694617615315_0.5294741984670541"},"_hasShrinkwrap":false},"1.0.5":{"name":"@amazing-kit/docker","version":"1.0.5","description":"Run docker commands in node.js (not all commands are supported yet)","main":"dist/index.js","type":"module","types":"dist/index.d.ts","scripts":{"test":"vitest run","test:watch":"vitest watch","build":"run-p build:source build:types","build:source":"vite build","build:types":"tsc --emitDeclarationOnly","build:watch":"vite build --watch","clean":"rimraf dist .turbo node_modules","prepublishOnly":"zx bin/prepublish.mjs"},"keywords":[],"author":"","license":"MIT","devDependencies":{"@types/node":"^20.6.0","npm-run-all":"^4.1.5","rimraf":"^5.0.1","typescript":"^5.2.2","vite":"^4.4.9","vitest":"^0.34.4"},"dependencies":{"zx":"^7.2.3"},"publishConfig":{"access":"public"},"gitHead":"8d1eb0f8a14c06eda2596e84f6a2c7aac56e1b71","_id":"@amazing-kit/docker@1.0.5","_nodeVersion":"20.2.0","_npmVersion":"9.6.6","dist":{"integrity":"sha512-LWczk4BtTMuPaeQRjd26zfviogsG4hG9SbM6uCiLQhuNDi7S1E8z8p8VQb6hR960NwLUvS7nHthbtxKPDHrxxg==","shasum":"47ace1ee24effdcd45dc3e4ee25a0f13a33b6b77","tarball":"https://registry.npmjs.org/@amazing-kit/docker/-/docker-1.0.5.tgz","fileCount":12,"unpackedSize":9055,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCuYRznZjyrLl/56rCiFpT8kIFol6p0o6PZKHsLBQqM/wIhAJEp34/cUvjsZgUT3MUbHl7qXjwj1xHNhAF/Id4gSQ5A"}]},"_npmUser":{"name":"wooandoo","email":"frederic.mascaro@gmail.com"},"directories":{},"maintainers":[{"name":"wooandoo","email":"frederic.mascaro@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/docker_1.0.5_1694617762697_0.7386670355002978"},"_hasShrinkwrap":false},"1.0.6":{"name":"@amazing-kit/docker","version":"1.0.6","description":"Run docker commands in node.js (not all commands are supported yet)","repository":{"type":"git","url":"git+https://github.com/amazing-kit/docker.git"},"keywords":["docker"],"author":{"name":"Frédéric Mascaro","email":"frederic.mascaro@gmail.com"},"license":"MIT","main":"dist/index.js","type":"module","types":"dist/index.d.ts","engines":{"node":">= 18.0.0"},"scripts":{"test":"vitest run","test:watch":"vitest watch","build":"run-p build:source build:types","build:source":"vite build","build:types":"tsc --emitDeclarationOnly","build:watch":"vite build --watch","clean":"rimraf dist .turbo node_modules","prepublishOnly":"zx bin/prepublish.mjs"},"devDependencies":{"@types/node":"^20.6.0","npm-run-all":"^4.1.5","rimraf":"^5.0.1","typescript":"^5.2.2","vite":"^4.4.9","vitest":"^0.34.4"},"dependencies":{"zx":"^7.2.3"},"publishConfig":{"access":"public"},"gitHead":"6e183fa9e57df8d9059ae4823d8e463b931869cd","bugs":{"url":"https://github.com/amazing-kit/docker/issues"},"homepage":"https://github.com/amazing-kit/docker#readme","_id":"@amazing-kit/docker@1.0.6","_nodeVersion":"20.2.0","_npmVersion":"9.6.6","dist":{"integrity":"sha512-gbkG/yYXwr9ENPQUiUFAzbvdG4zfG+tdXfOO+X57+7TKaldYV20A1kUL5/scoygshbvI57q3/n7Nw8f3x+H6WA==","shasum":"1de6cfcfdb557009ad2cb827d65d8019142285b5","tarball":"https://registry.npmjs.org/@amazing-kit/docker/-/docker-1.0.6.tgz","fileCount":12,"unpackedSize":10101,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDJH+RAaS3zxXCo/yD+D/57JVOSgGS/FT0H+izq1iu2jAIhAIaczQkPJrpd0GP/ufBG+j0t8aVALOZTcgtfVJ9o6SFu"}]},"_npmUser":{"name":"wooandoo","email":"frederic.mascaro@gmail.com"},"directories":{},"maintainers":[{"name":"wooandoo","email":"frederic.mascaro@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/docker_1.0.6_1694621341981_0.06404128371985363"},"_hasShrinkwrap":false}},"time":{"created":"2023-09-13T07:25:47.418Z","1.0.0":"2023-09-13T07:25:47.711Z","modified":"2023-09-13T16:09:02.469Z","1.0.1":"2023-09-13T07:42:24.408Z","1.0.2":"2023-09-13T08:14:15.015Z","1.0.3":"2023-09-13T08:32:20.155Z","1.0.4":"2023-09-13T15:06:55.683Z","1.0.5":"2023-09-13T15:09:22.956Z","1.0.6":"2023-09-13T16:09:02.241Z"},"maintainers":[{"name":"wooandoo","email":"frederic.mascaro@gmail.com"}],"description":"Run docker commands in node.js (not all commands are supported yet)","keywords":["docker"],"license":"MIT","readme":"# @amazing-kit/docker\n\nRun docker commands from nodejs\n- run\n- stop\n- ps\n\n## Install\n\n```sh\npnpm add @amazing-kit/docker\n```\n\n```ts\n// ESModule only\nimport docker from \"@amazing-kit/docker\"\n```\n\n## Get docker containers\n\n```ts\nconst all_containers = await docker.ps({ all: true })\n// get container data in JSON format\n```\n\n## Run a new docker container\n\n```ts\nawait docker.run(\"image_name\", {\n  // all options are optional\n  name: \"container_name\",\n  ports: [\n    { host: 8080, container: 80 }\n  ],\n  env: [\n    { name: \"ENV_NAME\", value: \"ENV_VALUE\"}\n  ],\n  volumes: [\n    { source: \"/host/path\", container: \"/container/path\", readonly: true }\n  ],\n  auto_remove: true, // default false\n  daemon: true,      // default false\n})\n```\n\n## Stop a docker container\n\n```ts\nawait docker.stop(\"container_name\", { forceKillAfter: 1000 })\n```\n\n## Alternatives\n\n- [dockerode](https://github.com/apocas/dockerode)\n- [docker-js](https://github.com/giper45/docker-js)\n- [zx](https://github.com/google/zx) -> not docker specific (execu docker CLI in JS)","readmeFilename":"README.md","homepage":"https://github.com/amazing-kit/docker#readme","repository":{"type":"git","url":"git+https://github.com/amazing-kit/docker.git"},"author":{"name":"Frédéric Mascaro","email":"frederic.mascaro@gmail.com"},"bugs":{"url":"https://github.com/amazing-kit/docker/issues"}}