@wyrd-company/dcb-linux-x64 0.0.0-stage → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +26 -0
- package/README.md +99 -2
- package/bin/dcb +0 -0
- package/package.json +29 -4
package/LICENSE
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Wyrd Company
|
|
4
|
+
|
|
5
|
+
Portions derived from devcontainers/cli (https://github.com/devcontainers/cli):
|
|
6
|
+
|
|
7
|
+
Copyright (c) Microsoft Corporation.
|
|
8
|
+
|
|
9
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
|
10
|
+
a copy of this software and associated documentation files (the
|
|
11
|
+
'Software'), to deal in the Software without restriction, including
|
|
12
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
|
13
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
|
14
|
+
permit persons to whom the Software is furnished to do so, subject to
|
|
15
|
+
the following conditions:
|
|
16
|
+
|
|
17
|
+
The above copyright notice and this permission notice shall be
|
|
18
|
+
included in all copies or substantial portions of the Software.
|
|
19
|
+
|
|
20
|
+
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
|
|
21
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
22
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
23
|
+
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
|
|
24
|
+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
|
|
25
|
+
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
|
26
|
+
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,3 +1,100 @@
|
|
|
1
|
-
#
|
|
1
|
+
# dcb
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
`dcb` builds and runs [development containers](https://containers.dev/) from a
|
|
4
|
+
`devcontainer.json`. It builds images on the Docker daemon's built-in BuildKit,
|
|
5
|
+
and creates, starts, and runs lifecycle commands in containers through the
|
|
6
|
+
Docker Engine API. Every command writes one JSON result line to stdout, except
|
|
7
|
+
help and a valid `exec` invocation.
|
|
8
|
+
|
|
9
|
+
Documentation is at [wyrd.foo/docs/dcb](https://wyrd.foo/docs/dcb), published
|
|
10
|
+
from [`docs/`](docs).
|
|
11
|
+
|
|
12
|
+
## Install
|
|
13
|
+
|
|
14
|
+
| Method | Command |
|
|
15
|
+
| --- | --- |
|
|
16
|
+
| Homebrew | `brew install wyrd-company/tools/dcb` |
|
|
17
|
+
| npm | `npm install --global @wyrd-company/dcb` |
|
|
18
|
+
| APT | `sudo apt install dcb` |
|
|
19
|
+
| RPM | `sudo dnf install dcb` |
|
|
20
|
+
| AUR | `paru -S dcb-bin` |
|
|
21
|
+
| Go 1.26+ | `go install github.com/wyrd-company/devcontainer-builder/cmd/dcb@latest` |
|
|
22
|
+
|
|
23
|
+
APT and RPM need the [repo.wyrd.foo](https://repo.wyrd.foo) package
|
|
24
|
+
repository. [Installation](https://wyrd.foo/docs/dcb/install) gives the setup
|
|
25
|
+
commands and the release archives.
|
|
26
|
+
|
|
27
|
+
`dcb` runs on Linux and macOS, on `amd64` and `arm64`. It needs a Docker Engine
|
|
28
|
+
that it can reach through the standard `DOCKER_HOST` environment; the `docker`
|
|
29
|
+
command is not needed. Podman is not supported.
|
|
30
|
+
|
|
31
|
+
## Use
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
dcb up --workspace-folder .
|
|
35
|
+
dcb exec --workspace-folder . -- sh -c 'id && pwd'
|
|
36
|
+
dcb down --workspace-folder .
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
```json
|
|
40
|
+
{"containerId":"3f1c…","outcome":"success","remoteUser":"vscode","remoteWorkspaceFolder":"/workspaces/project"}
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Build an image and push it for two platforms:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
dcb build --workspace-folder . \
|
|
47
|
+
--image-name registry.example.com/team/dev:1.0 \
|
|
48
|
+
--platform linux/amd64 --platform linux/arm64 \
|
|
49
|
+
--push
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
`dcb --help` lists every command. Exit code `0` is success, `1` is an
|
|
53
|
+
operation failure, and `2` is an invalid invocation, with a JSON error result.
|
|
54
|
+
After `exec` starts the container command, it passes the command's output
|
|
55
|
+
through and returns its exit code. See [Usage](https://wyrd.foo/docs/dcb/usage)
|
|
56
|
+
and [Configuration](https://wyrd.foo/docs/dcb/configuration).
|
|
57
|
+
|
|
58
|
+
`dcb skills install` writes an agent skill that describes these commands for
|
|
59
|
+
coding agents.
|
|
60
|
+
|
|
61
|
+
## Relation to the Dev Container CLI
|
|
62
|
+
|
|
63
|
+
`dcb` is a separate implementation of the
|
|
64
|
+
[Dev Container specification](https://containers.dev/implementors/spec/), with
|
|
65
|
+
the goal of feature parity with
|
|
66
|
+
[`devcontainers/cli`](https://github.com/devcontainers/cli). It uses the same
|
|
67
|
+
container labels and lifecycle marker files, so each tool finds containers that
|
|
68
|
+
the other created. Command names and flags follow upstream where the concept is
|
|
69
|
+
the same.
|
|
70
|
+
|
|
71
|
+
The [parity harness](test/parity) runs both CLIs on upstream fixtures and
|
|
72
|
+
reports the share of results that match. Some upstream behavior is not yet
|
|
73
|
+
matched. [Overview](https://wyrd.foo/docs/dcb/overview) lists the differences.
|
|
74
|
+
|
|
75
|
+
### Not yet supported
|
|
76
|
+
|
|
77
|
+
These upstream command families are not yet supported:
|
|
78
|
+
|
|
79
|
+
- [`outdated`](https://github.com/wyrd-company/devcontainer-builder/issues/20)
|
|
80
|
+
- [`upgrade`](https://github.com/wyrd-company/devcontainer-builder/issues/21)
|
|
81
|
+
- [Feature authoring commands under `features`](https://github.com/wyrd-company/devcontainer-builder/issues/22)
|
|
82
|
+
- [`templates`](https://github.com/wyrd-company/devcontainer-builder/issues/23)
|
|
83
|
+
|
|
84
|
+
## Go libraries
|
|
85
|
+
|
|
86
|
+
The packages under [`pkg/`](pkg) build images, run containers on Docker or
|
|
87
|
+
Kubernetes, and convert configurations into Kubernetes Pods. They can be
|
|
88
|
+
embedded in a service or an operator. See
|
|
89
|
+
[Go libraries](https://wyrd.foo/docs/dcb/library).
|
|
90
|
+
|
|
91
|
+
## Development
|
|
92
|
+
|
|
93
|
+
See [CONTRIBUTING.md](CONTRIBUTING.md). `task check` runs the checks that a
|
|
94
|
+
change must pass; `task parity` runs the parity harness.
|
|
95
|
+
|
|
96
|
+
## License
|
|
97
|
+
|
|
98
|
+
[MIT](LICENSE). The npm launcher and some release scripts are adapted from
|
|
99
|
+
other Wyrd Company projects under the Apache License 2.0; see
|
|
100
|
+
[`npm/NOTICE`](npm/NOTICE).
|
package/bin/dcb
ADDED
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,6 +1,31 @@
|
|
|
1
1
|
{
|
|
2
|
+
"description": "Build and run development containers",
|
|
3
|
+
"homepage": "https://github.com/wyrd-company/devcontainer-builder",
|
|
4
|
+
"repository": {
|
|
5
|
+
"type": "git",
|
|
6
|
+
"url": "git+https://github.com/wyrd-company/devcontainer-builder.git"
|
|
7
|
+
},
|
|
8
|
+
"license": "MIT",
|
|
9
|
+
"publishConfig": {
|
|
10
|
+
"access": "public",
|
|
11
|
+
"registry": "https://registry.npmjs.org"
|
|
12
|
+
},
|
|
13
|
+
"relationships": {
|
|
14
|
+
"references": [
|
|
15
|
+
"manifest"
|
|
16
|
+
]
|
|
17
|
+
},
|
|
2
18
|
"name": "@wyrd-company/dcb-linux-x64",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"
|
|
5
|
-
|
|
6
|
-
|
|
19
|
+
"version": "0.1.0",
|
|
20
|
+
"os": [
|
|
21
|
+
"linux"
|
|
22
|
+
],
|
|
23
|
+
"cpu": [
|
|
24
|
+
"x64"
|
|
25
|
+
],
|
|
26
|
+
"files": [
|
|
27
|
+
"bin/dcb",
|
|
28
|
+
"LICENSE",
|
|
29
|
+
"README.md"
|
|
30
|
+
]
|
|
31
|
+
}
|