@procedures/docker 0.2.3 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,52 @@
 # @procedures/docker
 
+## 0.3.0
+
+### Minor Changes
+
+- 2392f9e: More docker procedures (roadmap R41): `docker.compose.ps`, `docker.compose.logs`, `docker.compose.build`, `docker.compose.restart`, `docker.images`, `docker.inspect` (with `data`, the parsed JSON), `docker.volume.list`, `docker.volume.create`, `docker.volume.remove`, `docker.network.list`, `docker.network.create`, `docker.network.remove`, `docker.tag`, `docker.push` and `docker.prune`. Each one declares its effects and `calls: ["shell.run"]`. `docker.prune` is destructive and needs `confirm: true`.
+  
+  `docker.run` and `docker.exec` take `args`, the command as a list of arguments. R32 found that `command`, split at whitespace, cannot carry an argument with a space or quotes. `command` still works. The two together are an error, and `docker.exec` needs one of them.
+  
+  `docker.*` is a namespace of the MCP tools, so the dev-tools MCP server gets the new procedures as tools when `bundle-mcp` and the snapshots of `impl-mcp-dev` take them.
+
+### Patch Changes
+
+- c5528e4: Streams that can run without an end (roadmap R15). A procedure declares `stream: { unbounded: true }` in its metadata (`docker.logs`, for `follow`, and `shell.stream` do). `ProcedureServer` marks its stream response, and the faces that collect a stream obey the mark: HTTP without NDJSON answers 406 `NOT_ACCEPTABLE` at once (before, the request waited until a timeout), and the MCP transport stops the stream at its `streamLimits` (default 100 items or 30 seconds) and says so in the result (before, `docker.logs` with `follow` ended only at the time limit of 10 minutes).
+- Updated dependencies [ddea529]
+- Updated dependencies [b2a3e3a]
+- Updated dependencies [a8c47f1]
+- Updated dependencies [381ce3a]
+- Updated dependencies [0c627f8]
+- Updated dependencies [ae7f05f]
+- Updated dependencies [7873940]
+- Updated dependencies [a70d445]
+- Updated dependencies [bc70357]
+- Updated dependencies [07cc998]
+- Updated dependencies [a6b01a9]
+- Updated dependencies [c799cdd]
+- Updated dependencies [540f8d9]
+- Updated dependencies [b6daaec]
+- Updated dependencies [5b9264e]
+- Updated dependencies [956e88b]
+- Updated dependencies [ff62281]
+- Updated dependencies [d81d0ed]
+- Updated dependencies [aa67cc7]
+- Updated dependencies [061fa22]
+- Updated dependencies [cfb9d69]
+- Updated dependencies [43f7de5]
+- Updated dependencies [b07bb50]
+- Updated dependencies [4a3bfa1]
+- Updated dependencies [bd0b626]
+- Updated dependencies [a6be873]
+- Updated dependencies [fb30718]
+- Updated dependencies [c5528e4]
+- Updated dependencies [fee5d9c]
+- Updated dependencies [21f7743]
+- Updated dependencies [31a0b46]
+  - @procedures/client@0.3.0
+  - @procedures/shell@0.3.0
+
 ## 0.2.3
 
 ### Patch Changes

package/README.md

@@ -11,7 +11,7 @@
 
 ### Key Features
 
-- **Comprehensive Docker Coverage**: Run, build, pull, exec, stop, rm, ps, logs commands
+- **Comprehensive Docker Coverage**: Run, build, pull, push, tag, exec, stop, rm, ps, logs, images, inspect, volume, network and prune commands
 - **Docker Compose Support**: Up and down operations for multi-container applications
 - **Type-Safe Inputs**: Zod schemas for all inputs with full TypeScript support
 - **Shell Integration**: Leverages `client-shell` for reliable CLI execution
@@ -267,7 +267,8 @@ Run a Docker container.
   env?: Record<string, string>; // Environment variables
   detach?: boolean;           // Run in background (default: false)
   rm?: boolean;               // Auto-remove when stopped (default: false)
-  command?: string;           // Command to run in container
+  command?: string;           // Command to run in container, split at whitespace
+  args?: string[];            // The command as a list: each item is one argument (not with command)
   cwd?: string;               // Working directory for command
   timeout?: number;           // Command timeout in ms
 }
@@ -346,7 +347,8 @@ Execute a command in a running container.
 ```typescript
 {
   container: string;          // Required: Container name or ID
-  command: string;            // Required: Command to execute
+  command?: string;           // Command to execute, split at whitespace
+  args?: string[];            // The command as a list: each item is one argument. Give command or args
   interactive?: boolean;      // Allocate stdin (default: false)
   tty?: boolean;              // Allocate pseudo-TTY (default: false)
   workdir?: string;           // Working directory inside container
@@ -517,6 +519,41 @@ await client.exec(["docker", "compose", "down"], {
 });
 ```
 
+### More procedures (roadmap R41)
+
+Each procedure gives the common output type, and takes `cwd` and `timeout`. A failed command does not throw. A name, an image or a service that starts with `-` is refused, because docker reads it as an option. The effects column shows `metadata.effects`.
+
+| Procedure | Input | Effects |
+|---|---|---|
+| `docker.compose.ps` | `file`, `services`, `all`, `format` | reads docker and fs |
+| `docker.compose.logs` | `file`, `services`, `tail`, `since`, `timestamps` | reads docker and fs |
+| `docker.compose.build` | `file`, `services`, `noCache`, `pull`, `buildArgs` | reads docker, fs and network, writes docker and process, not destructive |
+| `docker.compose.restart` | `file`, `services`, `time` | reads docker and fs, writes docker |
+| `docker.images` | `repository`, `all`, `filter`, `format` | reads docker |
+| `docker.inspect` | `targets` (one or more), `type`, `format` | reads docker |
+| `docker.volume.list` | `filter`, `format` | reads docker |
+| `docker.volume.create` | `name`, `driver`, `labels` | writes docker, not destructive, idempotent |
+| `docker.volume.remove` | `volumes` (one or more), `force` | writes docker, destructive, idempotent |
+| `docker.network.list` | `filter`, `format` | reads docker |
+| `docker.network.create` | `name`, `driver`, `internal`, `labels` | writes docker, not destructive, idempotent |
+| `docker.network.remove` | `networks` (one or more) | writes docker, destructive, idempotent |
+| `docker.tag` | `source`, `target` | writes docker, idempotent |
+| `docker.push` | `image`, `allTags` | reads docker and network, writes network, idempotent |
+| `docker.prune` | `kind`, `all`, `volumes`, `filter`, `confirm` | writes docker, destructive, idempotent |
+
+- `docker.inspect` gives `data`: the parsed JSON of docker. With `format`, docker writes text, and `data` is absent.
+- `docker.compose.logs` does not follow the logs. It gives the lines that exist.
+- `docker.prune` needs `confirm: true`. The removed objects and their data are lost. The `kind` is `system` (the default), `container`, `image`, `volume`, `network` or `builder`.
+- `docker.tag` moves the name from another image. `docker.push` replaces the image of the tag in the registry.
+
+`docker.run` and `docker.exec` take `args`, a list of arguments, in place of `command`. Docker gets each item as one argument, so an argument can contain spaces and quotes. `command` still works, split at whitespace. The two together are an error.
+
+```typescript
+await client.exec(["docker", "exec"], { container: "db", args: ["psql", "-c", "SELECT 'a b'"] });
+const { data } = await client.exec(["docker", "inspect"], { targets: ["db"], type: "container" });
+await client.exec(["docker", "prune"], { kind: "image", all: true, confirm: true });
+```
+
 ## Types
 
 ### Input Types