@howdoi-cli/docker 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 howdoi-cli contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,34 @@
+# @howdoi-cli/docker
+
+**howdoi knowledge base — docker commands.**
+
+Part of the [howdoi](https://github.com/SiphoChris/howdoi-cli) ecosystem.
+
+## Install
+
+```bash
+npm install -g @howdoi-cli/docker
+```
+
+This also installs `@howdoi-cli/core` (the engine and `howdoi` binary) automatically.
+
+## Usage
+
+```bash
+howdoi <what you want to do>
+```
+
+## Install more knowledge bases
+
+```bash
+npm install -g @howdoi-cli/unix
+npm install -g @howdoi-cli/git
+npm install -g @howdoi-cli/ssh
+npm install -g @howdoi-cli/docker
+npm install -g @howdoi-cli/networking
+npm install -g @howdoi-cli/all
+```
+
+## License
+
+MIT

package/data/docker/docker-compose.yaml

@@ -0,0 +1,46 @@
+tool: docker compose
+category: docker
+description: Manage multi-container Docker applications
+package: "@howdoi-cli/docker"
+intents:
+  - start docker compose
+  - run docker compose
+  - stop docker compose
+  - restart docker compose services
+  - view docker compose logs
+  - rebuild docker compose
+  - scale docker compose service
+  - run command in compose service
+  - list compose services
+  - remove compose volumes
+examples:
+  - intent: start docker compose
+    title: Start all services in the background
+    command: docker compose up -d
+  - intent: start docker compose
+    title: Start services and show logs
+    command: docker compose up
+  - intent: stop docker compose
+    title: Stop all running services
+    command: docker compose down
+  - intent: remove compose volumes
+    title: Stop services and remove volumes
+    command: docker compose down -v
+  - intent: rebuild docker compose
+    title: Rebuild images and restart services
+    command: docker compose up -d --build
+  - intent: view docker compose logs
+    title: View logs for all services
+    command: docker compose logs
+  - intent: view docker compose logs
+    title: Follow logs for a specific service
+    command: docker compose logs -f service_name
+  - intent: run command in compose service
+    title: Run a command inside a running service
+    command: docker compose exec service_name bash
+  - intent: restart docker compose services
+    title: Restart a specific service
+    command: docker compose restart service_name
+  - intent: list compose services
+    title: List all services and their status
+    command: docker compose ps

package/data/docker/docker.yaml

@@ -0,0 +1,91 @@
+tool: docker
+category: docker
+description: Manage Docker containers, images, and volumes
+package: "@howdoi-cli/docker"
+intents:
+  - run docker container
+  - start container
+  - stop container
+  - list running containers
+  - list all containers
+  - remove container
+  - get shell inside container
+  - exec into container
+  - view container logs
+  - follow container logs
+  - inspect container
+  - restart container
+  - remove all stopped containers
+  - list docker images
+  - pull docker image
+  - remove docker image
+  - build docker image
+  - tag docker image
+  - push docker image
+  - run container in background
+  - map port in docker
+  - mount volume in docker
+  - pass environment variable to container
+  - copy file from container
+  - copy file to container
+examples:
+  - intent: list running containers
+    title: List all running containers
+    command: docker ps
+  - intent: list all containers
+    title: List all containers including stopped ones
+    command: docker ps -a
+  - intent: run docker container
+    title: Run a container interactively
+    command: docker run -it ubuntu bash
+  - intent: run container in background
+    title: Run a container in the background (detached)
+    command: docker run -d nginx
+  - intent: map port in docker
+    title: Run container and map host port to container port
+    command: docker run -p 8080:80 nginx
+  - intent: pass environment variable to container
+    title: Run container with environment variables
+    command: docker run -e NODE_ENV=production -e PORT=3000 myapp
+  - intent: mount volume in docker
+    title: Mount a local directory into a container
+    command: docker run -v $(pwd):/app node:18
+  - intent: get shell inside container
+    title: Open a bash shell inside a running container
+    command: docker exec -it container_name bash
+  - intent: view container logs
+    title: View logs of a container
+    command: docker logs container_name
+  - intent: follow container logs
+    title: Follow container logs in real time
+    command: docker logs -f container_name
+  - intent: stop container
+    title: Stop a running container
+    command: docker stop container_name
+  - intent: remove container
+    title: Remove a stopped container
+    command: docker rm container_name
+  - intent: remove all stopped containers
+    title: Remove all stopped containers at once
+    command: docker container prune
+  - intent: list docker images
+    title: List all local Docker images
+    command: docker images
+  - intent: pull docker image
+    title: Pull an image from Docker Hub
+    command: docker pull node:18
+  - intent: build docker image
+    title: Build an image from a Dockerfile
+    command: docker build -t myapp:latest .
+  - intent: remove docker image
+    title: Remove a local image
+    command: docker rmi myapp:latest
+  - intent: copy file from container
+    title: Copy a file from a container to your machine
+    command: docker cp container_name:/app/file.txt ./file.txt
+  - intent: copy file to container
+    title: Copy a file from your machine into a container
+    command: docker cp ./file.txt container_name:/app/file.txt
+  - intent: inspect container
+    title: Inspect full container details
+    command: docker inspect container_name

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@howdoi-cli/docker",
+  "version": "1.0.0",
+  "description": "Docker knowledge base for howdoi — containers, images, volumes, and more.",
+  "type": "module",
+  "files": [
+    "data",
+    "postinstall.mjs",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "postinstall": "node postinstall.mjs",
+    "publish:npm": "npm publish"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "howdoi": {
+    "type": "knowledge-base",
+    "dataDir": "data"
+  },
+  "dependencies": {
+    "@howdoi-cli/core": "^1.0.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "keywords": ["cli", "docker", "containers", "terminal", "howdoi"],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SiphoChris/howdoi-cli"
+  }
+}

package/postinstall.mjs

@@ -0,0 +1,45 @@
+#!/usr/bin/env node
+import { cpSync, mkdirSync, existsSync, readFileSync } from "fs";
+import { join, dirname, resolve } from "path";
+import { homedir } from "os";
+
+// process.argv[1] is always the path of the running script — reliable across
+// all package managers and working directories
+const scriptDir = dirname(resolve(process.argv[1]));
+const pkgJsonPath = join(scriptDir, "package.json");
+
+if (!existsSync(pkgJsonPath)) {
+  process.exit(0);
+}
+
+const pkgJson = JSON.parse(readFileSync(pkgJsonPath, "utf-8"));
+const pkgName = pkgJson.name.replace("@howdoi-cli/", "");
+
+// Skip in monorepo dev context — check for workspace root two levels up
+const monoRootPkg = resolve(scriptDir, "..", "..", "package.json");
+if (existsSync(monoRootPkg)) {
+  try {
+    const root = JSON.parse(readFileSync(monoRootPkg, "utf-8"));
+    if (root.workspaces) {
+      console.log(`[howdoi] Dev mode — skipping XDG install for ${pkgJson.name}`);
+      process.exit(0);
+    }
+  } catch { /* continue */ }
+}
+
+const srcData = join(scriptDir, "data");
+if (!existsSync(srcData)) {
+  process.exit(0);
+}
+
+const xdgBase = process.env.XDG_DATA_HOME ?? join(homedir(), ".local", "share");
+const dest = join(xdgBase, "howdoi", pkgName);
+
+try {
+  mkdirSync(dest, { recursive: true });
+  cpSync(srcData, dest, { recursive: true });
+  console.log(`[howdoi] ✓ ${pkgJson.name}@${pkgJson.version} → ${dest}`);
+} catch (err) {
+  console.warn(`[howdoi] Warning: could not copy data: ${err.message}`);
+  console.warn(`[howdoi] howdoi will still work via node_modules fallback.`);
+}