@brik64/cli 0.1.0-beta.2 → 0.1.0-beta.3
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/CONTRIBUTING.md +38 -0
- package/NOTICE +1 -1
- package/README.md +147 -22
- package/SECURITY.md +54 -0
- package/docs/BRIK_METHODOLOGY_TRANSITION.md +17 -16
- package/docs/DISTRIBUTION_ROADMAP.md +41 -0
- package/docs/GITHUB_NPM_PUBLISHING.md +15 -4
- package/docs/GITHUB_PACKAGES_PUBLISHING.md +46 -0
- package/docs/GITHUB_REPO_GOVERNANCE.md +97 -0
- package/docs/LINUX_HETZNER_TESTING.md +17 -13
- package/docs/MACOS_LOCAL_TESTING.md +16 -13
- package/docs/PLATFORM_MATRIX.md +12 -7
- package/docs/RELEASE_COPY_MANUAL.md +4 -4
- package/docs/REPOSITORY_MAP.md +100 -0
- package/docs/REPO_BOUNDARY.md +15 -16
- package/docs/WIKI_HOME.md +50 -0
- package/evidence/pcd-certificates/cli_certify_emit.pcd.cert.json +1 -1
- package/evidence/pcd-certificates/cli_core.pcd.cert.json +2 -2
- package/evidence/pcd-certificates/cli_init_policy.pcd.cert.json +1 -1
- package/evidence/pcd-certificates/cli_polymer.pcd.cert.json +2 -2
- package/evidence/pcd-seed/README.md +16 -5
- package/package.json +4 -2
- package/packaging/macos-local/README.md +14 -7
- package/pcd/README.md +23 -18
- package/pcd/cli_core.pcd +2 -2
- package/pcd/cli_polymer.pcd +1 -1
- package/src/brik.js +6 -2
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Contributing
|
|
2
|
+
|
|
3
|
+
BRIK64 CLI is a public beta release repository maintained by BRIK64 INC.
|
|
4
|
+
|
|
5
|
+
This repository is public for inspection, installation, issue reporting, release
|
|
6
|
+
review, and package transparency.
|
|
7
|
+
|
|
8
|
+
## Issues
|
|
9
|
+
|
|
10
|
+
Issues are open for public bug reports, docs mismatches, release metadata
|
|
11
|
+
problems, and reproducible CLI beta feedback.
|
|
12
|
+
|
|
13
|
+
When opening an issue:
|
|
14
|
+
|
|
15
|
+
- include the CLI version;
|
|
16
|
+
- include the platform;
|
|
17
|
+
- include the shortest reproduction command sequence;
|
|
18
|
+
- redact secrets, private source, credentials, tokens, and customer data.
|
|
19
|
+
|
|
20
|
+
Good issue categories:
|
|
21
|
+
|
|
22
|
+
- CLI command behavior.
|
|
23
|
+
- Install or package metadata mismatch.
|
|
24
|
+
- GitHub Release, npm, or GitHub Packages mismatch.
|
|
25
|
+
- Docs or changelog mismatch.
|
|
26
|
+
- Platform packaging evidence gap.
|
|
27
|
+
|
|
28
|
+
## Pull Requests
|
|
29
|
+
|
|
30
|
+
External pull requests are not accepted for this repository. BRIK64 lands
|
|
31
|
+
changes through authorized maintainers so release evidence, package metadata,
|
|
32
|
+
public claims, licenses, checksums, workflows, and docs stay aligned.
|
|
33
|
+
|
|
34
|
+
Please open an issue instead of a pull request.
|
|
35
|
+
|
|
36
|
+
## Security
|
|
37
|
+
|
|
38
|
+
Use `SECURITY.md` for vulnerability reporting guidance.
|
package/NOTICE
CHANGED
|
@@ -9,7 +9,7 @@ validation, and versioned release evidence. Expanded platform support and
|
|
|
9
9
|
stronger certification surfaces remain governed by the BRIK64 evidence process
|
|
10
10
|
and commercial licensing terms.
|
|
11
11
|
|
|
12
|
-
Public product information: https://brik64.com
|
|
12
|
+
Public product information: https://brik64.com
|
|
13
13
|
Documentation: https://docs.brik64.com/cli/install
|
|
14
14
|
Repository: https://github.com/brik64/brik64-cli
|
|
15
15
|
Package: https://www.npmjs.com/package/@brik64/cli
|
package/README.md
CHANGED
|
@@ -3,16 +3,12 @@
|
|
|
3
3
|
```text
|
|
4
4
|
╔══════════════════════════════════════════════════════╗
|
|
5
5
|
║ ║
|
|
6
|
-
║ ██████╗ ██████╗ ██╗██╗ ██╗ ██████╗ ██╗ ██╗
|
|
7
|
-
║ ██╔══██╗██╔══██╗ ██║██║ ██╔╝██╔════╝ ██║ ██║
|
|
8
|
-
║ ██████╔╝██████╔╝ ██║█████╔╝ ███████╗ ███████║
|
|
9
|
-
║ ██╔══██╗██╔══██╗ ██║██╔═██╗ ██╔═══██╗╚════██║
|
|
10
|
-
║ ██████╔╝██║ ██║ ██║██║ ██╗╚██████╔╝ ██║
|
|
11
|
-
║ ╚═════╝ ╚═╝ ╚═╝ ╚═╝╚═╝ ╚═╝ ╚═════╝ ╚═╝
|
|
12
|
-
║ ║
|
|
13
|
-
║ BRIK64 SYSTEM BOOT ║
|
|
14
|
-
║ SOFTWARE LOGIC COMPILER ║
|
|
15
|
-
║ MAKE SOFTWARE REVIEWABLE AGAIN ║
|
|
6
|
+
║ ██████╗ ██████╗ ██╗██╗ ██╗ ██████╗ ██╗ ██╗ ║
|
|
7
|
+
║ ██╔══██╗██╔══██╗ ██║██║ ██╔╝██╔════╝ ██║ ██║ ║
|
|
8
|
+
║ ██████╔╝██████╔╝ ██║█████╔╝ ███████╗ ███████║ ║
|
|
9
|
+
║ ██╔══██╗██╔══██╗ ██║██╔═██╗ ██╔═══██╗╚════██║ ║
|
|
10
|
+
║ ██████╔╝██║ ██║ ██║██║ ██╗╚██████╔╝ ██║ ║
|
|
11
|
+
║ ╚═════╝ ╚═╝ ╚═╝ ╚═╝╚═╝ ╚═╝ ╚═════╝ ╚═╝ ║
|
|
16
12
|
║ ║
|
|
17
13
|
╚══════════════════════════════════════════════════════╝
|
|
18
14
|
```
|
|
@@ -24,11 +20,65 @@ from their own machine.
|
|
|
24
20
|
|
|
25
21
|
Generated code is easy to ship. Trust is the harder part. BRIK64 CLI is built
|
|
26
22
|
for teams that want software work to carry clearer structure, repeatable
|
|
27
|
-
evidence, and release language that stays aligned with
|
|
23
|
+
evidence, and release language that stays aligned with bounded artifacts.
|
|
24
|
+
|
|
25
|
+
BRIK64 is based on Digital Circuitality: the idea that critical software should
|
|
26
|
+
be shaped as inspectable, composable logic rather than treated only as text.
|
|
27
|
+
In BRIK64 workflows, `.brik` project state, PCD seed material, local evidence,
|
|
28
|
+
and release metadata are kept close to the code so a team can review how a
|
|
29
|
+
software surface is described, packaged, and promoted.
|
|
30
|
+
|
|
31
|
+
PCD, or Program Circuit Description, is the structural description layer used by
|
|
32
|
+
BRIK64 to model software logic as reviewable pieces. In this beta, the CLI gives
|
|
33
|
+
developers an entry point into that workflow: project scaffolding, local PCD
|
|
34
|
+
examples, evidence files, package metadata, and public-beta release checks.
|
|
35
|
+
Stronger certification and compiler claims remain governed by the evidence gates
|
|
36
|
+
maintained in `brik64-prod`.
|
|
37
|
+
|
|
38
|
+
Start from the BRIK64 homepage: https://brik64.com
|
|
39
|
+
|
|
40
|
+
For install instructions, technical context, and methodology notes, read the
|
|
41
|
+
docs: https://docs.brik64.com
|
|
42
|
+
|
|
43
|
+
## Official Channels
|
|
44
|
+
|
|
45
|
+
- Website: [brik64.com](https://brik64.com)
|
|
46
|
+
- Docs: [docs.brik64.com](https://docs.brik64.com)
|
|
47
|
+
- npmjs primary package:
|
|
48
|
+
[@brik64/cli](https://www.npmjs.com/package/@brik64/cli)
|
|
49
|
+
- GitHub Releases:
|
|
50
|
+
[brik64/brik64-cli releases](https://github.com/brik64/brik64-cli/releases)
|
|
51
|
+
- GitHub Packages mirror:
|
|
52
|
+
[@brik64/cli package mirror](https://github.com/brik64/brik64-cli/pkgs/npm/cli)
|
|
53
|
+
- Agent skills:
|
|
54
|
+
[brik64-tools-skills](https://github.com/brik64/brik64-tools-skills)
|
|
55
|
+
- Public beta roadmap:
|
|
56
|
+
[BRIK64 CLI beta project](https://github.com/orgs/brik64/projects/1)
|
|
57
|
+
|
|
58
|
+
## Public Interaction Policy
|
|
59
|
+
|
|
60
|
+
This repository is public for package inspection, release review, install
|
|
61
|
+
metadata, bounded evidence review, and issue reporting.
|
|
62
|
+
|
|
63
|
+
Allowed:
|
|
64
|
+
|
|
65
|
+
- Open issues for reproducible CLI beta bugs.
|
|
66
|
+
- Open issues for docs, release, npm, checksum, or install metadata mismatches.
|
|
67
|
+
- Report security concerns through `SECURITY.md`.
|
|
68
|
+
|
|
69
|
+
Not accepted:
|
|
70
|
+
|
|
71
|
+
- External pull requests.
|
|
72
|
+
- External direct commits.
|
|
73
|
+
- Public edits to release evidence, license text, package metadata, workflows,
|
|
74
|
+
install paths, or public claim surfaces.
|
|
75
|
+
|
|
76
|
+
BRIK64 lands changes through authorized maintainers so package metadata, public
|
|
77
|
+
claims, checksums, licenses, release notes, and docs remain aligned.
|
|
28
78
|
|
|
29
79
|
## Status
|
|
30
80
|
|
|
31
|
-
Current beta: `0.1.0-beta.
|
|
81
|
+
Current beta: [`0.1.0-beta.3`](https://github.com/brik64/brik64-cli/releases/tag/v0.1.0-beta.3)
|
|
32
82
|
|
|
33
83
|
This beta is intended for evaluation, local workflow trials, package smoke
|
|
34
84
|
testing, and bounded PCD/evidence review. The current public beta surface is
|
|
@@ -54,9 +104,47 @@ brik --version
|
|
|
54
104
|
brik help
|
|
55
105
|
```
|
|
56
106
|
|
|
57
|
-
Public web surface: https://brik64.com
|
|
107
|
+
Public web surface: [brik64.com](https://brik64.com)
|
|
108
|
+
|
|
109
|
+
Docs: [CLI install guide](https://docs.brik64.com/cli/install)
|
|
110
|
+
|
|
111
|
+
GitHub Packages mirror:
|
|
112
|
+
|
|
113
|
+
```sh
|
|
114
|
+
npm install -g @brik64/cli@beta --registry=https://npm.pkg.github.com
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
The npmjs package remains the primary public install path. GitHub Packages is a
|
|
118
|
+
GitHub-visible mirror for release inspection and organization package inventory.
|
|
119
|
+
|
|
120
|
+
## CLI And Agent Skill
|
|
121
|
+
|
|
122
|
+
BRIK64 is designed for humans and AI agents working together. Use the CLI for
|
|
123
|
+
local project actions and the official `brik64` skill for agent behavior,
|
|
124
|
+
claim-safe reporting, `.brik` traceability, PCD 1.0 workflow, and
|
|
125
|
+
`AGENTS.md` managed-instruction rules.
|
|
58
126
|
|
|
59
|
-
|
|
127
|
+
Skill repository:
|
|
128
|
+
[brik64/brik64-tools-skills](https://github.com/brik64/brik64-tools-skills)
|
|
129
|
+
|
|
130
|
+
Recommended agent workflow:
|
|
131
|
+
|
|
132
|
+
```text
|
|
133
|
+
read docs.brik64.com -> check current skill repo -> inspect repo state
|
|
134
|
+
-> run brik commands -> preserve .brik traceability -> report bounded evidence
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
Install or read the official agent skill from the public skill repository before
|
|
138
|
+
using BRIK64 agent workflows:
|
|
139
|
+
|
|
140
|
+
```text
|
|
141
|
+
https://github.com/brik64/brik64-tools-skills
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
`brik init` prepares local BRIK64 metadata. It does not create or modify
|
|
145
|
+
`AGENTS.md`. The current CLI beta does not expose `brik skill` subcommands; any
|
|
146
|
+
agent instruction installation must remain explicit, reviewable, and
|
|
147
|
+
consent-based.
|
|
60
148
|
|
|
61
149
|
## What It Does
|
|
62
150
|
|
|
@@ -68,9 +156,34 @@ Docs: https://docs.brik64.com/cli/install
|
|
|
68
156
|
- Establishes the public package surface for controlled CLI evaluation and future
|
|
69
157
|
SDK alignment.
|
|
70
158
|
|
|
159
|
+
## Repository Map
|
|
160
|
+
|
|
161
|
+
Use this map to understand what each public path contains before installing,
|
|
162
|
+
auditing, or filing an issue.
|
|
163
|
+
|
|
164
|
+
| Path | What it contains |
|
|
165
|
+
| --- | --- |
|
|
166
|
+
| `src/brik.js` | Executable Node.js entry point for the current public beta `brik` command. |
|
|
167
|
+
| `tests/smoke.sh` | Local smoke test for version, help, init, skill install policy, status, and certify command behavior. |
|
|
168
|
+
| `pcd/` | Candidate PCD seed material that describes the intended CLI command structure and composition path. |
|
|
169
|
+
| `evidence/` | Public beta evidence notes and generated-review placeholders used for package inspection. |
|
|
170
|
+
| `packaging/` | Platform packaging notes and local package review material for release lanes. |
|
|
171
|
+
| `docs/` | Release, distribution, governance, platform, publishing, testing, and methodology documentation. |
|
|
172
|
+
| `.github/` | Repository governance, CI, package publishing, CodeQL, Dependabot, issue templates, and maintainer ownership rules. |
|
|
173
|
+
| `.brik/manifest.json` | BRIK64 project metadata for local traceability. It is not a certificate. |
|
|
174
|
+
| `README.md` | Public entry point for installation, scope, repo map, release assets, and license summary. |
|
|
175
|
+
| `LICENSE` | Proprietary beta license terms for BRIK64 CLI. |
|
|
176
|
+
| `NOTICE` | Copyright and third-party notice surface. |
|
|
177
|
+
| `SECURITY.md` | Security reporting policy and supported beta version scope. |
|
|
178
|
+
| `CONTRIBUTING.md` | Public interaction policy: issues accepted, external pull requests not accepted. |
|
|
179
|
+
| `package.json` | npm package metadata, executable mapping, scripts, package files, and beta keywords. |
|
|
180
|
+
|
|
181
|
+
For a fuller file-by-file description, read
|
|
182
|
+
[`docs/REPOSITORY_MAP.md`](docs/REPOSITORY_MAP.md).
|
|
183
|
+
|
|
71
184
|
## Current Scope
|
|
72
185
|
|
|
73
|
-
The `0.1.0-beta.
|
|
186
|
+
The `0.1.0-beta.3` release is scoped to public beta evaluation. It is centered
|
|
74
187
|
on local developer workflow, macOS package validation, PCD seed material, and
|
|
75
188
|
release evidence review. Production certification, expanded platform support,
|
|
76
189
|
and advanced compiler-methodology claims are promoted only when the matching
|
|
@@ -79,9 +192,20 @@ BRIK64 gates and evidence packs authorize that scope.
|
|
|
79
192
|
|
|
80
193
|
## Release Assets
|
|
81
194
|
|
|
82
|
-
Current beta
|
|
195
|
+
Current beta availability:
|
|
196
|
+
|
|
197
|
+
| Surface | Status | Link |
|
|
198
|
+
| --- | --- | --- |
|
|
199
|
+
| npmjs package | Primary public beta install path | [@brik64/cli on npm](https://www.npmjs.com/package/@brik64/cli) |
|
|
200
|
+
| GitHub Release | Versioned release notes and beta asset review | [v0.1.0-beta.3](https://github.com/brik64/brik64-cli/releases/tag/v0.1.0-beta.3) |
|
|
201
|
+
| GitHub Packages | GitHub-visible npm mirror for organization package inventory | [@brik64/cli mirror](https://github.com/brik64/brik64-cli/pkgs/npm/cli) |
|
|
202
|
+
| Docs | Install and usage documentation | [CLI install guide](https://docs.brik64.com/cli/install) |
|
|
203
|
+
| Website | Public product entry point | [brik64.com](https://brik64.com) |
|
|
204
|
+
|
|
205
|
+
Current platform asset:
|
|
83
206
|
|
|
84
|
-
- macOS Apple Silicon package for local CLI evaluation
|
|
207
|
+
- macOS Apple Silicon package for local CLI evaluation, listed in the
|
|
208
|
+
[v0.1.0-beta.3 GitHub Release](https://github.com/brik64/brik64-cli/releases/tag/v0.1.0-beta.3).
|
|
85
209
|
|
|
86
210
|
Planned release lanes:
|
|
87
211
|
|
|
@@ -99,13 +223,14 @@ The public beta package is tied to versioned release artifacts, checksums, and
|
|
|
99
223
|
operator gates. Use the GitHub release assets and checksums to review the exact
|
|
100
224
|
package candidate before treating any install path as authoritative.
|
|
101
225
|
|
|
102
|
-
GitHub release:
|
|
226
|
+
GitHub release:
|
|
227
|
+
[v0.1.0-beta.3](https://github.com/brik64/brik64-cli/releases/tag/v0.1.0-beta.3)
|
|
103
228
|
|
|
104
229
|
## Copyright And License
|
|
105
230
|
|
|
106
231
|
Copyright (c) 2026 BRIK64 INC. All rights reserved.
|
|
107
232
|
|
|
108
|
-
See
|
|
109
|
-
evaluation software from BRIK64 INC. Production, commercial,
|
|
110
|
-
redistribution, partner, enterprise, regulated, or
|
|
111
|
-
requires written commercial terms from BRIK64 INC.
|
|
233
|
+
See [LICENSE](LICENSE) and [NOTICE](NOTICE). BRIK64 CLI public beta is
|
|
234
|
+
proprietary evaluation software from BRIK64 INC. Production, commercial,
|
|
235
|
+
hosted, redistribution, partner, enterprise, regulated, or
|
|
236
|
+
certification-oriented use requires written commercial terms from BRIK64 INC.
|
package/SECURITY.md
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
BRIK64 CLI is public beta evaluation software from BRIK64 INC.
|
|
4
|
+
|
|
5
|
+
## Supported Versions
|
|
6
|
+
|
|
7
|
+
| Version | Status |
|
|
8
|
+
| --- | --- |
|
|
9
|
+
| `0.1.0-beta.x` | Public beta security review and patch lane |
|
|
10
|
+
| Earlier beta artifacts | Superseded |
|
|
11
|
+
|
|
12
|
+
## Reporting A Vulnerability
|
|
13
|
+
|
|
14
|
+
Report suspected vulnerabilities through GitHub Security Advisories for this
|
|
15
|
+
repository when available, or contact BRIK64 through the public company website:
|
|
16
|
+
|
|
17
|
+
https://brik64.com
|
|
18
|
+
|
|
19
|
+
Do not include secrets, private source code, customer data, raw credentials, or
|
|
20
|
+
unredacted infrastructure details in public issues.
|
|
21
|
+
|
|
22
|
+
Use public issues only for non-sensitive bugs, docs mismatches, package metadata,
|
|
23
|
+
install failures, or release evidence questions. If an issue may expose a token,
|
|
24
|
+
private path, customer data, unpublished source, infrastructure detail, or
|
|
25
|
+
exploit path, use a private security report path instead.
|
|
26
|
+
|
|
27
|
+
## Public Beta Scope
|
|
28
|
+
|
|
29
|
+
Security review for this repository covers the public CLI package surface,
|
|
30
|
+
release metadata, package workflows, local smoke tests, PCD seed files, and
|
|
31
|
+
bounded evidence artifacts included with the beta.
|
|
32
|
+
|
|
33
|
+
`brik64-prod` remains the authority for methodology, certification boundaries,
|
|
34
|
+
evidence gates, compiler claim authorization, and release approval.
|
|
35
|
+
|
|
36
|
+
## Disclosure Handling
|
|
37
|
+
|
|
38
|
+
BRIK64 will triage reports by affected version, exploitability, package
|
|
39
|
+
surface, and evidence impact. Fixes may be shipped as new beta versions,
|
|
40
|
+
repository advisories, release notes, or docs updates depending on scope.
|
|
41
|
+
|
|
42
|
+
## Maintainer Controls
|
|
43
|
+
|
|
44
|
+
The public repository is maintained through the `brik64-cli-maintainers` team.
|
|
45
|
+
External pull requests are not accepted. Changes to package metadata, release
|
|
46
|
+
evidence, license text, workflows, public claims, or install paths must land
|
|
47
|
+
through authorized maintainers, protected branch rules, and passing checks.
|
|
48
|
+
|
|
49
|
+
## Dependency And Workflow Security
|
|
50
|
+
|
|
51
|
+
Dependabot is configured for npm and GitHub Actions update detection. CodeQL
|
|
52
|
+
default setup and CI smoke/package checks provide repository-level regression
|
|
53
|
+
signals. These checks are operational security controls; they do not certify the
|
|
54
|
+
CLI or expand the public beta claim boundary.
|
|
@@ -1,25 +1,26 @@
|
|
|
1
|
-
#
|
|
1
|
+
# BRIK64 CLI Methodology Transition
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
This document describes how the CLI beta moves from a practical JavaScript
|
|
4
|
+
package surface toward the BRIK64 PCD-first methodology.
|
|
4
5
|
|
|
5
|
-
|
|
6
|
-
being made usable. Once the beta CLI is functionally validated, CLI semantics
|
|
7
|
-
must move to BRIK64 methodology:
|
|
6
|
+
## Transition Path
|
|
8
7
|
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
4. compile the CLI through the approved compiler path;
|
|
13
|
-
5. make future CLI iterations by modifying PCD logic, not by treating emitted
|
|
14
|
-
target code as the semantic source.
|
|
8
|
+
The current beta can use operational source and package artifacts while the CLI
|
|
9
|
+
is being made usable. As the methodology matures, the CLI should move through
|
|
10
|
+
this path:
|
|
15
11
|
|
|
16
|
-
|
|
12
|
+
1. Maintain `.brik` project metadata for traceability.
|
|
13
|
+
2. Expand CLI PCDs as the intended semantic source.
|
|
14
|
+
3. Certify candidate PCDs through the active prod gates.
|
|
15
|
+
4. Compile the CLI through the approved compiler path.
|
|
16
|
+
5. Make future CLI iterations by modifying PCD logic before target output.
|
|
17
17
|
|
|
18
|
-
|
|
19
|
-
release readiness or Rust independence.
|
|
18
|
+
## Current Boundary
|
|
20
19
|
|
|
21
|
-
The
|
|
22
|
-
and
|
|
20
|
+
The public beta remains centered on local CLI usage, package inspection, PCD
|
|
21
|
+
seed review, and release evidence. Stronger methodology language should be
|
|
22
|
+
promoted only after the matching `brik64-prod` gates and platform evidence
|
|
23
|
+
authorize it.
|
|
23
24
|
|
|
24
25
|
## Required Evidence Before Stronger Claims
|
|
25
26
|
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# BRIK64 CLI Distribution Roadmap
|
|
2
|
+
|
|
3
|
+
This roadmap tracks public beta distribution channels for BRIK64 CLI.
|
|
4
|
+
|
|
5
|
+
## Current Public Channels
|
|
6
|
+
|
|
7
|
+
- npmjs: primary package registry for `@brik64/cli`.
|
|
8
|
+
- GitHub Releases: release notes, source archive, and platform assets.
|
|
9
|
+
- GitHub Packages: organization-visible npm mirror, published separately from
|
|
10
|
+
npmjs through `publish-github-packages-beta.yml`.
|
|
11
|
+
|
|
12
|
+
## Required Next Channels
|
|
13
|
+
|
|
14
|
+
| Channel | Target | Status | Evidence Required |
|
|
15
|
+
| --- | --- | --- | --- |
|
|
16
|
+
| macOS Apple Silicon | npm/GitHub release asset | Current beta lane | package smoke, checksum, release manifest |
|
|
17
|
+
| macOS Intel | GitHub release asset, curl, Homebrew | Planned | Intel runner/install smoke, checksum, release manifest |
|
|
18
|
+
| Debian Linux | `.deb`, curl, apt-ready artifact | Planned | Debian build, install smoke, checksum, release manifest |
|
|
19
|
+
| Ubuntu Linux | `.deb`, curl, apt-ready artifact | Planned | Ubuntu build, install smoke, checksum, release manifest |
|
|
20
|
+
| Windows PC | installer/zip, GitHub release asset | Planned | Windows runner smoke, checksum, release manifest |
|
|
21
|
+
| Homebrew | tap formula | Planned | formula audit, install smoke, checksum binding |
|
|
22
|
+
| curl installer | GCP-hosted install script | Planned | signed script, checksum verification, HTTPS availability |
|
|
23
|
+
|
|
24
|
+
## Automation Boundary
|
|
25
|
+
|
|
26
|
+
Each channel must publish only after platform-specific package, install, checksum,
|
|
27
|
+
and release-evidence gates pass. Docs, npm metadata, GitHub Releases,
|
|
28
|
+
GitHub Packages, Homebrew, curl, and brik64.com should reference the same
|
|
29
|
+
version and artifact evidence.
|
|
30
|
+
|
|
31
|
+
## Project Tracking
|
|
32
|
+
|
|
33
|
+
The GitHub Project should track each channel as a separate issue with:
|
|
34
|
+
|
|
35
|
+
- target platform;
|
|
36
|
+
- distribution channel;
|
|
37
|
+
- required artifact;
|
|
38
|
+
- smoke command;
|
|
39
|
+
- checksum or signature requirement;
|
|
40
|
+
- docs/Mintlify update requirement;
|
|
41
|
+
- release blocker status.
|
|
@@ -12,6 +12,11 @@ Use the manual workflow:
|
|
|
12
12
|
.github/workflows/publish-npm-beta.yml
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
+
This publishes to npmjs. It does not publish to GitHub Packages. Use
|
|
16
|
+
`docs/GITHUB_PACKAGES_PUBLISHING.md` and
|
|
17
|
+
`.github/workflows/publish-github-packages-beta.yml` for the separate GitHub
|
|
18
|
+
Packages mirror.
|
|
19
|
+
|
|
15
20
|
Inputs:
|
|
16
21
|
|
|
17
22
|
- `version`: exact `package.json` version, for example `0.1.0-beta.1`.
|
|
@@ -20,9 +25,14 @@ Inputs:
|
|
|
20
25
|
|
|
21
26
|
Required GitHub configuration:
|
|
22
27
|
|
|
23
|
-
- Environment: `npm-beta`.
|
|
24
28
|
- Secret: `NPM_TOKEN` with publish rights for `@brik64/cli`.
|
|
25
|
-
-
|
|
29
|
+
- Manual confirmation input: `confirm_public_beta` must be typed for every
|
|
30
|
+
publish run.
|
|
31
|
+
|
|
32
|
+
This workflow intentionally does not attach a GitHub deployment environment.
|
|
33
|
+
Publishing an npm package is a package-release operation, not a web deployment,
|
|
34
|
+
so keeping the workflow environment-free avoids misleading deployment-status
|
|
35
|
+
labels in the public GitHub UI.
|
|
26
36
|
|
|
27
37
|
## Workflow Checks
|
|
28
38
|
|
|
@@ -51,8 +61,9 @@ To migrate:
|
|
|
51
61
|
3. Test one beta publish from GitHub Actions.
|
|
52
62
|
4. After the trusted publisher works, restrict or revoke traditional npm tokens.
|
|
53
63
|
|
|
54
|
-
Until the trusted publisher is configured on npmjs.com, keep using
|
|
55
|
-
|
|
64
|
+
Until the trusted publisher is configured on npmjs.com, keep using the
|
|
65
|
+
repository or organization `NPM_TOKEN` secret with the manual confirmation
|
|
66
|
+
input.
|
|
56
67
|
|
|
57
68
|
## Copy Boundary
|
|
58
69
|
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# GitHub Packages Publishing Runbook
|
|
2
|
+
|
|
3
|
+
GitHub Packages is a separate npm registry mirror for organization visibility
|
|
4
|
+
inside GitHub. Publishing `@brik64/cli` to npmjs does not create a visible
|
|
5
|
+
package under the GitHub repository Packages tab.
|
|
6
|
+
|
|
7
|
+
## Registry
|
|
8
|
+
|
|
9
|
+
```text
|
|
10
|
+
https://npm.pkg.github.com
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Package:
|
|
14
|
+
|
|
15
|
+
```text
|
|
16
|
+
@brik64/cli
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Workflow
|
|
20
|
+
|
|
21
|
+
Use the manual workflow:
|
|
22
|
+
|
|
23
|
+
```text
|
|
24
|
+
.github/workflows/publish-github-packages-beta.yml
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Inputs:
|
|
28
|
+
|
|
29
|
+
- `version`: exact `package.json` version, for example `0.1.0-beta.3`.
|
|
30
|
+
- `dist_tag`: normally `beta`; use `latest` only when intentionally aligning the
|
|
31
|
+
GitHub Packages default install path.
|
|
32
|
+
- `confirm_github_packages_beta`: must equal
|
|
33
|
+
`PUBLISH_BRIK64_CLI_GITHUB_PACKAGES`.
|
|
34
|
+
|
|
35
|
+
The workflow uses `GITHUB_TOKEN` with `packages: write`. It does not need the
|
|
36
|
+
npmjs `NPM_TOKEN`.
|
|
37
|
+
|
|
38
|
+
## Boundary
|
|
39
|
+
|
|
40
|
+
npmjs remains the primary public registry for install commands. GitHub Packages
|
|
41
|
+
is a GitHub-visible mirror for release inspection, organization package
|
|
42
|
+
inventory, and future internal automation.
|
|
43
|
+
|
|
44
|
+
Do not treat GitHub Packages publication as new release evidence. It mirrors the
|
|
45
|
+
same package version and must remain aligned with npmjs, GitHub Releases,
|
|
46
|
+
docs.brik64.com, and brik64.com.
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
# GitHub Repository Governance
|
|
2
|
+
|
|
3
|
+
This repository is public so developers can inspect BRIK64 CLI beta releases,
|
|
4
|
+
read package metadata, download artifacts, and open issues.
|
|
5
|
+
|
|
6
|
+
It is not an external contribution repository.
|
|
7
|
+
|
|
8
|
+
## Ownership
|
|
9
|
+
|
|
10
|
+
- Organization: `brik64`
|
|
11
|
+
- Repository: `brik64/brik64-cli`
|
|
12
|
+
- Maintainer team: `brik64/brik64-cli-maintainers`
|
|
13
|
+
- Initial maintainers: `brik64-admin`, `carlosjperez`
|
|
14
|
+
|
|
15
|
+
`CODEOWNERS` assigns the full repository to the maintainer team.
|
|
16
|
+
|
|
17
|
+
## Public Interaction Policy
|
|
18
|
+
|
|
19
|
+
Allowed:
|
|
20
|
+
|
|
21
|
+
- Open issues.
|
|
22
|
+
- Report reproducible CLI beta bugs.
|
|
23
|
+
- Report docs, release, npm, checksum, or install metadata mismatches.
|
|
24
|
+
- Report security concerns through the security policy.
|
|
25
|
+
|
|
26
|
+
Not accepted:
|
|
27
|
+
|
|
28
|
+
- External pull requests.
|
|
29
|
+
- External direct commits.
|
|
30
|
+
- Public changes to release evidence, license text, package metadata, or docs
|
|
31
|
+
claim surfaces.
|
|
32
|
+
|
|
33
|
+
BRIK64 lands changes through authorized maintainers so release evidence,
|
|
34
|
+
package metadata, public claims, licenses, checksums, and docs stay aligned.
|
|
35
|
+
|
|
36
|
+
## Required Repository Settings
|
|
37
|
+
|
|
38
|
+
Recommended public repo settings:
|
|
39
|
+
|
|
40
|
+
- Issues: enabled.
|
|
41
|
+
- Wiki: enabled.
|
|
42
|
+
- Projects: disabled unless used for public release tracking.
|
|
43
|
+
- Merge commit, squash merge, and rebase merge: disabled for public PR paths.
|
|
44
|
+
- Auto merge: disabled.
|
|
45
|
+
- Delete branch on merge: enabled.
|
|
46
|
+
- Web commit signoff: enabled.
|
|
47
|
+
- Homepage: `https://brik64.com`.
|
|
48
|
+
- Repository topics: `brik64`, `brik`, `cli`, `pcd`, `evidence`,
|
|
49
|
+
`software-trust`, `developer-tools`, `public-beta`, `macos`, `command-line`.
|
|
50
|
+
|
|
51
|
+
Recommended `main` branch protection:
|
|
52
|
+
|
|
53
|
+
- Restrict pushes to `brik64-cli-maintainers`.
|
|
54
|
+
- Require signed commits.
|
|
55
|
+
- Require linear history.
|
|
56
|
+
- Block force pushes.
|
|
57
|
+
- Block deletions.
|
|
58
|
+
- Require conversation resolution.
|
|
59
|
+
|
|
60
|
+
## Security And Code Quality
|
|
61
|
+
|
|
62
|
+
Repository security should include:
|
|
63
|
+
|
|
64
|
+
- Secret scanning enabled.
|
|
65
|
+
- Secret scanning push protection enabled.
|
|
66
|
+
- Dependabot security updates enabled.
|
|
67
|
+
- Dependabot version update config for npm and GitHub Actions.
|
|
68
|
+
- CodeQL default setup for JavaScript analysis.
|
|
69
|
+
- CI smoke and package checks.
|
|
70
|
+
|
|
71
|
+
Dependabot PRs should be reviewed by `brik64-cli-maintainers` and merged only
|
|
72
|
+
after protected branch checks pass. Dependency update PRs are maintenance
|
|
73
|
+
signals, not release promotion evidence.
|
|
74
|
+
|
|
75
|
+
Do not add a custom CodeQL advanced workflow while GitHub CodeQL default setup is
|
|
76
|
+
enabled for this repository. GitHub rejects SARIF from advanced configuration
|
|
77
|
+
when default setup is active.
|
|
78
|
+
|
|
79
|
+
## Docs And Mintlify Changelog
|
|
80
|
+
|
|
81
|
+
The publish workflow dispatches `brik64-cli-release` to
|
|
82
|
+
`brik64/brik64-docs-site` when `BRIK64_DOCS_REPO_DISPATCH_TOKEN` is configured.
|
|
83
|
+
|
|
84
|
+
Required secret:
|
|
85
|
+
|
|
86
|
+
```text
|
|
87
|
+
BRIK64_DOCS_REPO_DISPATCH_TOKEN
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
The token should be fine-grained and scoped to trigger repository dispatch or
|
|
91
|
+
workflow dispatch in `brik64/brik64-docs-site`. The receiving docs repository
|
|
92
|
+
should update `releases/changelog.mdx`, rebuild Mintlify output, and deploy docs.
|
|
93
|
+
|
|
94
|
+
The GitHub App installation token rollout announced in May 2026 means any app or
|
|
95
|
+
automation that creates installation tokens must treat `ghs_` tokens as opaque
|
|
96
|
+
and avoid fixed-length token assumptions. This repo's workflows do not parse
|
|
97
|
+
GitHub App installation tokens.
|
|
@@ -1,27 +1,31 @@
|
|
|
1
1
|
# Linux Hetzner Testing
|
|
2
2
|
|
|
3
|
-
Hetzner is the Linux
|
|
3
|
+
Hetzner is the Linux validation surface for BRIK64 CLI beta packaging.
|
|
4
4
|
|
|
5
|
-
Scope
|
|
6
|
-
|
|
7
|
-
-
|
|
8
|
-
-
|
|
9
|
-
-
|
|
5
|
+
## Scope
|
|
6
|
+
|
|
7
|
+
- Debian x64 package and install checks.
|
|
8
|
+
- Ubuntu x64 package and install checks.
|
|
9
|
+
- Fedora x64 package and install checks when that lane opens.
|
|
10
|
+
- Alpine x64 musl only with a musl-specific artifact or an explicit scope
|
|
10
11
|
decision.
|
|
11
12
|
|
|
12
|
-
Required
|
|
13
|
+
## Required Evidence Per Distro
|
|
14
|
+
|
|
13
15
|
- distro identity (`/etc/os-release`);
|
|
14
16
|
- architecture (`uname -m`);
|
|
15
17
|
- native binary path;
|
|
16
|
-
- no wrapper evidence;
|
|
17
18
|
- `brik --version` output;
|
|
18
19
|
- BRIK64 ASCII startup output;
|
|
19
20
|
- command-contract smoke;
|
|
20
21
|
- PCD/certify/emit workflow smoke;
|
|
21
22
|
- behavior PASS report.
|
|
22
23
|
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
24
|
+
## Promotion Path
|
|
25
|
+
|
|
26
|
+
Each distro lane should publish its own artifact, checksum, install smoke, and
|
|
27
|
+
release manifest before it is promoted through GitHub Releases, curl/GCP, docs,
|
|
28
|
+
or brik64.com. Linux wording should name the validated distro lane instead of
|
|
29
|
+
collapsing all Linux distributions into one status.
|
|
30
|
+
|
|
31
|
+
Windows remains a separate validation lane with its own runner and install smoke.
|
|
@@ -6,19 +6,22 @@ Current local platform:
|
|
|
6
6
|
- OS: macOS / Darwin
|
|
7
7
|
- Architecture: arm64
|
|
8
8
|
|
|
9
|
-
Scope
|
|
10
|
-
|
|
11
|
-
-
|
|
12
|
-
-
|
|
13
|
-
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
-
|
|
19
|
-
-
|
|
20
|
-
|
|
21
|
-
|
|
9
|
+
## Scope
|
|
10
|
+
|
|
11
|
+
- Local CLI execution.
|
|
12
|
+
- Local install path checks.
|
|
13
|
+
- Local command-contract checks.
|
|
14
|
+
- Apple Silicon package smoke for the current beta lane.
|
|
15
|
+
|
|
16
|
+
## Evidence Still Needed For Broader Promotion
|
|
17
|
+
|
|
18
|
+
- macOS Intel runner or host evidence.
|
|
19
|
+
- Windows evidence.
|
|
20
|
+
- Per-artifact checksum and release manifest binding.
|
|
21
|
+
- Release authorization from the active BRIK64 evidence process.
|
|
22
|
+
|
|
23
|
+
## Required Evidence Before Marking macOS Local Ready
|
|
24
|
+
|
|
22
25
|
- local binary path;
|
|
23
26
|
- `brik --version` output;
|
|
24
27
|
- BRIK64 ASCII startup output;
|
package/docs/PLATFORM_MATRIX.md
CHANGED
|
@@ -2,11 +2,16 @@
|
|
|
2
2
|
|
|
3
3
|
| Platform | Status | Required Evidence |
|
|
4
4
|
| --- | --- | --- |
|
|
5
|
-
| macOS
|
|
6
|
-
|
|
|
7
|
-
| Linux
|
|
8
|
-
| Linux
|
|
9
|
-
| Linux
|
|
10
|
-
|
|
|
5
|
+
| macOS Apple Silicon | current beta lane | package smoke, checksum, release manifest |
|
|
6
|
+
| macOS Intel | planned | Intel host or runner install smoke, checksum, release manifest |
|
|
7
|
+
| Debian Linux x64 | planned | Debian package/install smoke, checksum, release manifest |
|
|
8
|
+
| Ubuntu Linux x64 | planned | Ubuntu package/install smoke, checksum, release manifest |
|
|
9
|
+
| Fedora Linux x64 | future lane | Fedora package/install smoke or explicit scope decision |
|
|
10
|
+
| Alpine Linux x64 musl | future lane | musl-specific artifact or explicit scope decision |
|
|
11
|
+
| Windows x64 | planned | Windows runner smoke, checksum, release manifest |
|
|
11
12
|
|
|
12
|
-
|
|
13
|
+
## Public Wording Rule
|
|
14
|
+
|
|
15
|
+
Describe each platform only at the evidence level it has reached. Linux package
|
|
16
|
+
language should name the distro lane, and macOS language should distinguish
|
|
17
|
+
Apple Silicon from Intel until both lanes have passed their own checks.
|
|
@@ -8,11 +8,11 @@ and aligned with BRIK64 evidence boundaries.
|
|
|
8
8
|
## Authority
|
|
9
9
|
|
|
10
10
|
- Product surface: BRIK64 CLI.
|
|
11
|
-
- Current public beta: `0.1.0-beta.
|
|
12
|
-
- Public web surface: https://brik64.com
|
|
11
|
+
- Current public beta: `0.1.0-beta.3`.
|
|
12
|
+
- Public web surface: https://brik64.com
|
|
13
13
|
- Docs: https://docs.brik64.com/cli/install
|
|
14
14
|
- Package: https://www.npmjs.com/package/@brik64/cli
|
|
15
|
-
- Release: https://github.com/brik64/brik64-cli/releases/tag/v0.1.0-beta.
|
|
15
|
+
- Release: https://github.com/brik64/brik64-cli/releases/tag/v0.1.0-beta.3
|
|
16
16
|
- Evidence authority: `brik64-prod` gates, manifests, checksums, and release
|
|
17
17
|
reports.
|
|
18
18
|
- Implementation surface: `brik64-cli` source, package metadata, tests, PCD seed
|
|
@@ -160,7 +160,7 @@ brik --version
|
|
|
160
160
|
brik help
|
|
161
161
|
```
|
|
162
162
|
|
|
163
|
-
Public web surface: https://brik64.com
|
|
163
|
+
Public web surface: https://brik64.com
|
|
164
164
|
|
|
165
165
|
Docs: https://docs.brik64.com/cli/install
|
|
166
166
|
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# BRIK64 CLI Repository Map
|
|
2
|
+
|
|
3
|
+
This map describes the public files and folders in `brik64/brik64-cli`.
|
|
4
|
+
It is intended for package reviewers, beta users, security reporters, and
|
|
5
|
+
maintainers who need to understand what each path is for.
|
|
6
|
+
|
|
7
|
+
## Root Files
|
|
8
|
+
|
|
9
|
+
| Path | Description |
|
|
10
|
+
| --- | --- |
|
|
11
|
+
| `README.md` | Primary public entry point for BRIK64 CLI install instructions, beta scope, official channels, repository map, release assets, and license summary. |
|
|
12
|
+
| `package.json` | npm package manifest for `@brik64/cli`, including package version, description, binary mapping, scripts, keywords, publish config, and package file allowlist. |
|
|
13
|
+
| `LICENSE` | Proprietary beta license for BRIK64 CLI. The package is public for evaluation and inspection, not open source redistribution. |
|
|
14
|
+
| `NOTICE` | Copyright notice and third-party notice surface for the public beta package. |
|
|
15
|
+
| `SECURITY.md` | Security reporting policy, supported beta version scope, and private reporting route. |
|
|
16
|
+
| `CONTRIBUTING.md` | Public interaction policy. Issues are accepted for reproducible beta bugs and metadata mismatches; external pull requests are not accepted. |
|
|
17
|
+
| `.gitignore` | Local Git ignore rules for generated files, dependency directories, package outputs, logs, and temporary artifacts. |
|
|
18
|
+
| `.npmignore` | npm packaging exclusions for repository-only files that should not ship in the published package. |
|
|
19
|
+
|
|
20
|
+
## Executable CLI
|
|
21
|
+
|
|
22
|
+
| Path | Description |
|
|
23
|
+
| --- | --- |
|
|
24
|
+
| `src/` | Executable CLI source directory for the current beta. |
|
|
25
|
+
| `src/brik.js` | Node.js command entry point exposed as `brik` by npm. It implements the current public beta command behavior. |
|
|
26
|
+
|
|
27
|
+
## Tests
|
|
28
|
+
|
|
29
|
+
| Path | Description |
|
|
30
|
+
| --- | --- |
|
|
31
|
+
| `tests/` | Local test directory for current beta smoke checks. |
|
|
32
|
+
| `tests/smoke.sh` | Shell smoke test covering basic CLI execution, help/version output, project initialization behavior, `AGENTS.md` non-mutation policy, certify/emit behavior, target generation, and fail-closed unsupported targets. |
|
|
33
|
+
|
|
34
|
+
## PCD Seed Material
|
|
35
|
+
|
|
36
|
+
| Path | Description |
|
|
37
|
+
| --- | --- |
|
|
38
|
+
| `pcd/` | Candidate PCD seed material for moving CLI behavior toward a PCD-first BRIK64 methodology. These files are review material, not release certificates. |
|
|
39
|
+
| `pcd/README.md` | Folder-level explanation of current PCD seed role, promotion path, and authority boundary. |
|
|
40
|
+
| `pcd/cli_core.pcd` | Candidate command contract seed for core CLI behavior. |
|
|
41
|
+
| `pcd/cli_init_policy.pcd` | Candidate command contract seed for initialization and agent-file consent policy. |
|
|
42
|
+
| `pcd/cli_certify_emit.pcd` | Candidate command contract seed for bounded certification-output behavior. |
|
|
43
|
+
| `pcd/cli_polymer.pcd` | Candidate composition contract that binds the CLI command PCD seeds before a future compile route. |
|
|
44
|
+
|
|
45
|
+
## Evidence And Packaging
|
|
46
|
+
|
|
47
|
+
| Path | Description |
|
|
48
|
+
| --- | --- |
|
|
49
|
+
| `evidence/` | Public beta evidence area for package inspection and generated-review material. |
|
|
50
|
+
| `evidence/pcd-seed/` | Generated PCD seed review material used to keep methodology work inspectable without presenting it as certification. |
|
|
51
|
+
| `evidence/pcd-seed/README.md` | Explanation of how seed evidence should be read and what must happen before stronger release language is allowed. |
|
|
52
|
+
| `packaging/` | Packaging notes and release-lane material for platform-specific package work. |
|
|
53
|
+
| `packaging/macos-local/` | macOS local package review material for the current beta lane. |
|
|
54
|
+
| `packaging/macos-local/README.md` | macOS local packaging scope, package review expectations, and promotion requirements. |
|
|
55
|
+
|
|
56
|
+
## Documentation
|
|
57
|
+
|
|
58
|
+
| Path | Description |
|
|
59
|
+
| --- | --- |
|
|
60
|
+
| `docs/REPOSITORY_MAP.md` | This file-by-file public repository map. |
|
|
61
|
+
| `docs/BRIK_METHODOLOGY_TRANSITION.md` | Methodology transition plan for moving the CLI from executable beta source toward PCD-first implementation and evidence-backed promotion. |
|
|
62
|
+
| `docs/DISTRIBUTION_ROADMAP.md` | Distribution roadmap for npm, GitHub Releases, GitHub Packages, curl/GCP, Homebrew, macOS Intel, Linux, and Windows lanes. |
|
|
63
|
+
| `docs/GITHUB_NPM_PUBLISHING.md` | npm publishing workflow notes for the public beta package. |
|
|
64
|
+
| `docs/GITHUB_PACKAGES_PUBLISHING.md` | GitHub Packages mirror workflow notes and verification boundary. |
|
|
65
|
+
| `docs/GITHUB_REPO_GOVERNANCE.md` | Repository governance policy for branch protection, maintainer ownership, issue flow, package publication, and public interaction controls. |
|
|
66
|
+
| `docs/LINUX_HETZNER_TESTING.md` | Linux test plan and operator guidance for Debian/Ubuntu lanes using remote execution infrastructure. |
|
|
67
|
+
| `docs/MACOS_LOCAL_TESTING.md` | macOS local test plan and operator guidance for current Apple Silicon package validation. |
|
|
68
|
+
| `docs/PLATFORM_MATRIX.md` | Platform support matrix for current beta support and planned release lanes. |
|
|
69
|
+
| `docs/RELEASE_COPY_MANUAL.md` | Standardized release-copy guide for npm, GitHub Releases, package descriptions, changelog entries, and public keywords. |
|
|
70
|
+
| `docs/REPO_BOUNDARY.md` | Public repository boundary: what this repo owns, what `brik64-prod` owns, and what must not be claimed from this repo alone. |
|
|
71
|
+
| `docs/WIKI_HOME.md` | Versioned wiki-home content while GitHub Wiki remote access remains under operational review. |
|
|
72
|
+
|
|
73
|
+
## GitHub Governance
|
|
74
|
+
|
|
75
|
+
| Path | Description |
|
|
76
|
+
| --- | --- |
|
|
77
|
+
| `.github/CODEOWNERS` | Maintainer ownership rules for protected files and review-required changes. |
|
|
78
|
+
| `.github/PULL_REQUEST_TEMPLATE.md` | Internal maintainer checklist for protected changes, claim-safety review, package impact, and evidence updates. |
|
|
79
|
+
| `.github/dependabot.yml` | Dependabot grouping and review configuration for GitHub Actions and npm ecosystem updates. |
|
|
80
|
+
| `.github/ISSUE_TEMPLATE/` | Public issue templates for beta bugs, docs/package metadata mismatches, and security-report routing. |
|
|
81
|
+
| `.github/workflows/ci.yml` | Main CI workflow for smoke tests and package-content checks. |
|
|
82
|
+
| `.github/workflows/codeql.yml` | CodeQL workflow configuration where custom analysis is needed. |
|
|
83
|
+
| `.github/workflows/publish-npm-beta.yml` | Manual npm beta publication workflow for authorized maintainers. |
|
|
84
|
+
| `.github/workflows/publish-github-packages-beta.yml` | Manual GitHub Packages beta mirror workflow for authorized maintainers. |
|
|
85
|
+
|
|
86
|
+
## BRIK64 Traceability
|
|
87
|
+
|
|
88
|
+
| Path | Description |
|
|
89
|
+
| --- | --- |
|
|
90
|
+
| `.brik/` | BRIK64 local project metadata directory. |
|
|
91
|
+
| `.brik/manifest.json` | Local traceability manifest for the CLI repo. It is operational metadata and is not a formal certificate. |
|
|
92
|
+
|
|
93
|
+
## Authority Boundary
|
|
94
|
+
|
|
95
|
+
This repository owns the public CLI package surface, local beta source, package
|
|
96
|
+
metadata, package smoke checks, public repo governance, and beta documentation.
|
|
97
|
+
|
|
98
|
+
`brik64-prod` remains the authority for release gates, certificate boundaries,
|
|
99
|
+
compiler evidence, promotion decisions, and any stronger public claim
|
|
100
|
+
authorization.
|
package/docs/REPO_BOUNDARY.md
CHANGED
|
@@ -2,29 +2,28 @@
|
|
|
2
2
|
|
|
3
3
|
## Lives Here
|
|
4
4
|
|
|
5
|
-
- CLI source code.
|
|
6
|
-
- CLI tests and fixtures.
|
|
7
|
-
- Platform packaging scripts.
|
|
8
|
-
- Local beta artifacts.
|
|
9
|
-
- Per-version
|
|
5
|
+
- Public beta CLI source code.
|
|
6
|
+
- CLI smoke tests and fixtures.
|
|
7
|
+
- Platform packaging scripts and wrappers.
|
|
8
|
+
- Local beta artifacts and package metadata.
|
|
9
|
+
- Per-version release notes, runbooks, and distribution docs.
|
|
10
10
|
|
|
11
|
-
##
|
|
11
|
+
## Authority Boundary
|
|
12
12
|
|
|
13
|
-
-
|
|
14
|
-
|
|
15
|
-
-
|
|
16
|
-
|
|
17
|
-
- Prod evidence source of truth.
|
|
13
|
+
- `brik64-cli` owns implementation, public package metadata, distribution
|
|
14
|
+
workflows, issue templates, and release-surface documentation for the CLI beta.
|
|
15
|
+
- `brik64-prod` owns methodology gates, evidence authority, release decision,
|
|
16
|
+
compiler evidence, certificate boundaries, and public claim authorization.
|
|
18
17
|
|
|
19
|
-
##
|
|
18
|
+
## Public Surface Rule
|
|
20
19
|
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
20
|
+
The public repository should help developers inspect, install, and report on the
|
|
21
|
+
CLI beta without exposing private engines, internal gates, private evidence
|
|
22
|
+
stores, raw credentials, or unsupported certification language.
|
|
24
23
|
|
|
25
24
|
## Platform Scope
|
|
26
25
|
|
|
27
26
|
- macOS local testing can run on the current development machine.
|
|
28
27
|
- Linux testing should run on the Hetzner runner and must be split by distro
|
|
29
|
-
family
|
|
28
|
+
family.
|
|
30
29
|
- Windows testing remains pending until a real Windows PC/runner is available.
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# BRIK64 CLI Public Beta
|
|
2
|
+
|
|
3
|
+
BRIK64 CLI is the public beta command-line surface for local BRIK64 project
|
|
4
|
+
workflows, PCD-oriented structure, bounded evidence review, and claim-safe
|
|
5
|
+
project scaffolding.
|
|
6
|
+
|
|
7
|
+
## Official Links
|
|
8
|
+
|
|
9
|
+
- Website: https://brik64.com
|
|
10
|
+
- Docs: https://docs.brik64.com
|
|
11
|
+
- npm: https://www.npmjs.com/package/@brik64/cli
|
|
12
|
+
- GitHub release: https://github.com/brik64/brik64-cli/releases
|
|
13
|
+
|
|
14
|
+
## Public Interaction
|
|
15
|
+
|
|
16
|
+
This repository is public for inspection, installation, issue reporting, release
|
|
17
|
+
review, and package transparency.
|
|
18
|
+
|
|
19
|
+
Allowed:
|
|
20
|
+
|
|
21
|
+
- Open issues for reproducible CLI beta bugs.
|
|
22
|
+
- Open issues for docs, npm, release, checksum, or install metadata mismatches.
|
|
23
|
+
- Report security concerns using the repository security policy.
|
|
24
|
+
|
|
25
|
+
Not accepted:
|
|
26
|
+
|
|
27
|
+
- External pull requests.
|
|
28
|
+
- External direct commits.
|
|
29
|
+
- Public edits to release evidence, license text, package metadata, or public
|
|
30
|
+
claim surfaces.
|
|
31
|
+
|
|
32
|
+
BRIK64 lands changes through authorized maintainers.
|
|
33
|
+
|
|
34
|
+
## Current Beta
|
|
35
|
+
|
|
36
|
+
Current beta: `0.1.0-beta.3`
|
|
37
|
+
|
|
38
|
+
Install:
|
|
39
|
+
|
|
40
|
+
```sh
|
|
41
|
+
npm install -g @brik64/cli@beta
|
|
42
|
+
brik --version
|
|
43
|
+
brik help
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Evidence Boundary
|
|
47
|
+
|
|
48
|
+
`brik64-prod` remains the authority for methodology, release gates, evidence
|
|
49
|
+
contracts, certification boundaries, compiler claim authorization, and release
|
|
50
|
+
approval.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"schemaVersion": "brik64.cli_local_candidate_certificate.v1",
|
|
3
|
-
"generatedAt": "2026-06-
|
|
3
|
+
"generatedAt": "2026-06-03T20:12:17Z",
|
|
4
4
|
"pcd": {
|
|
5
5
|
"path": "pcd/cli_certify_emit.pcd",
|
|
6
6
|
"sha256": "1d73245ebee8592a4eeacdb4b99398baf7c5ddfa3c88c5927f924a871eee7147"
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"schemaVersion": "brik64.cli_local_candidate_certificate.v1",
|
|
3
|
-
"generatedAt": "2026-06-
|
|
3
|
+
"generatedAt": "2026-06-03T20:12:17Z",
|
|
4
4
|
"pcd": {
|
|
5
5
|
"path": "pcd/cli_core.pcd",
|
|
6
|
-
"sha256": "
|
|
6
|
+
"sha256": "a2337d9d359061d5c655320ad5fb64c2acbea0ed077840bc61c049dbf387419e"
|
|
7
7
|
},
|
|
8
8
|
"certificate": {
|
|
9
9
|
"kind": "local_candidate_certificate",
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"schemaVersion": "brik64.cli_local_candidate_certificate.v1",
|
|
3
|
-
"generatedAt": "2026-06-
|
|
3
|
+
"generatedAt": "2026-06-03T20:12:17Z",
|
|
4
4
|
"pcd": {
|
|
5
5
|
"path": "pcd/cli_init_policy.pcd",
|
|
6
6
|
"sha256": "fae8cf2f18ba00b337236a46ee7d212b1437c7b4eae812ca1e3506651ffdb31d"
|
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"schemaVersion": "brik64.cli_local_candidate_certificate.v1",
|
|
3
|
-
"generatedAt": "2026-06-
|
|
3
|
+
"generatedAt": "2026-06-03T20:12:17Z",
|
|
4
4
|
"pcd": {
|
|
5
5
|
"path": "pcd/cli_polymer.pcd",
|
|
6
|
-
"sha256": "
|
|
6
|
+
"sha256": "db285a12918a9fe4d50f80054e66d240d71d4ff0dd3031e495201a7dee936f71"
|
|
7
7
|
},
|
|
8
8
|
"certificate": {
|
|
9
9
|
"kind": "local_candidate_certificate",
|
|
@@ -1,7 +1,18 @@
|
|
|
1
|
-
# PCD Seed Evidence
|
|
1
|
+
# PCD Seed Evidence
|
|
2
2
|
|
|
3
|
-
This directory is reserved for
|
|
4
|
-
|
|
3
|
+
This directory is reserved for reports generated from the candidate PCD source
|
|
4
|
+
in `pcd/`.
|
|
5
5
|
|
|
6
|
-
|
|
7
|
-
|
|
6
|
+
## Current Role
|
|
7
|
+
|
|
8
|
+
- Holds future evidence generated from PCD seed review.
|
|
9
|
+
- Keeps PCD methodology evidence separate from executable CLI source.
|
|
10
|
+
- Provides a stable location for future gate outputs, manifests, and review
|
|
11
|
+
notes tied to the PCD seed material.
|
|
12
|
+
|
|
13
|
+
## Evidence Boundary
|
|
14
|
+
|
|
15
|
+
Public beta install and package metadata are supported by the release artifacts
|
|
16
|
+
and workflows documented in this repository. Stronger compiler, fixpoint,
|
|
17
|
+
platform, or certification language belongs to fresh evidence from the relevant
|
|
18
|
+
BRIK64 gates before it is promoted publicly.
|
package/package.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@brik64/cli",
|
|
3
|
-
"version": "0.1.0-beta.
|
|
3
|
+
"version": "0.1.0-beta.3",
|
|
4
4
|
"private": false,
|
|
5
5
|
"description": "BRIK64 CLI public beta for local PCD workflows, bounded evidence review, and claim-safe project scaffolding.",
|
|
6
|
-
"homepage": "https://brik64.com
|
|
6
|
+
"homepage": "https://brik64.com",
|
|
7
7
|
"repository": {
|
|
8
8
|
"type": "git",
|
|
9
9
|
"url": "git+https://github.com/brik64/brik64-cli.git"
|
|
@@ -49,6 +49,8 @@
|
|
|
49
49
|
"README.md",
|
|
50
50
|
"LICENSE",
|
|
51
51
|
"NOTICE",
|
|
52
|
+
"SECURITY.md",
|
|
53
|
+
"CONTRIBUTING.md",
|
|
52
54
|
".brik/manifest.json"
|
|
53
55
|
]
|
|
54
56
|
}
|
|
@@ -1,15 +1,22 @@
|
|
|
1
1
|
# macOS Local Bootstrap Wrapper
|
|
2
2
|
|
|
3
|
-
This directory contains
|
|
3
|
+
This directory contains the local macOS wrapper used to exercise the public beta
|
|
4
|
+
CLI during package and command smoke testing.
|
|
4
5
|
|
|
5
6
|
```bash
|
|
6
7
|
export PATH="/Users/carlosjperez/Documents/GitHub/brik64-cli/packaging/macos-local:$PATH"
|
|
7
8
|
brik --version
|
|
8
9
|
```
|
|
9
10
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
-
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
|
|
11
|
+
## Current Role
|
|
12
|
+
|
|
13
|
+
- Provides a local `brik` command wrapper for macOS testing.
|
|
14
|
+
- Depends on the local Node.js runtime.
|
|
15
|
+
- Supports install-path and command-contract checks before platform packages are
|
|
16
|
+
promoted.
|
|
17
|
+
|
|
18
|
+
## Promotion Path
|
|
19
|
+
|
|
20
|
+
Native macOS release assets should ship with platform-specific checksum,
|
|
21
|
+
install-smoke, and release-manifest evidence before they are promoted through
|
|
22
|
+
GitHub Releases, curl/GCP, Homebrew, docs, or brik64.com.
|
package/pcd/README.md
CHANGED
|
@@ -1,24 +1,29 @@
|
|
|
1
|
-
#
|
|
1
|
+
# BRIK64 CLI PCD Seeds
|
|
2
2
|
|
|
3
|
-
This directory contains
|
|
4
|
-
|
|
5
|
-
|
|
3
|
+
This directory contains the public beta PCD seed material for the local `brik`
|
|
4
|
+
CLI. These files describe the intended command structure and composition path
|
|
5
|
+
used to move the CLI toward a PCD-first BRIK64 methodology.
|
|
6
6
|
|
|
7
|
-
Current
|
|
7
|
+
## Current Role
|
|
8
8
|
|
|
9
|
-
-
|
|
10
|
-
-
|
|
11
|
-
|
|
12
|
-
- `cli_polymer.pcd`
|
|
13
|
-
command PCD seeds before
|
|
14
|
-
-
|
|
15
|
-
|
|
9
|
+
- `src/brik.js` remains the executable CLI source for the current beta.
|
|
10
|
+
- `cli_core.pcd`, `cli_init_policy.pcd`, and `cli_certify_emit.pcd` describe
|
|
11
|
+
candidate command contracts.
|
|
12
|
+
- `cli_polymer.pcd` describes the candidate composition contract that binds the
|
|
13
|
+
command PCD seeds before a future compile route.
|
|
14
|
+
- The files in this directory are review material for beta methodology, package
|
|
15
|
+
inspection, and future compiler-aligned work.
|
|
16
16
|
|
|
17
|
-
|
|
17
|
+
## Promotion Path
|
|
18
18
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
19
|
+
Before these seeds can support stronger public release language, BRIK64 must:
|
|
20
|
+
|
|
21
|
+
1. Complete candidate PCD coverage for CLI behavior.
|
|
22
|
+
2. Certify candidate PCDs with the active gate stack.
|
|
23
|
+
3. Validate the polymer/composition PCD against command PCDs.
|
|
22
24
|
4. Compile the CLI through the BRIK compiler path.
|
|
23
|
-
5. Run macOS, Linux distro, and Windows
|
|
24
|
-
6.
|
|
25
|
+
5. Run platform execution reports for macOS, Linux distro lanes, and Windows.
|
|
26
|
+
6. Publish release-boundary evidence from `brik64-prod`.
|
|
27
|
+
|
|
28
|
+
`brik64-prod` remains the authority for release gates, certificate boundaries,
|
|
29
|
+
compiler evidence, and public claim authorization.
|
package/pcd/cli_core.pcd
CHANGED
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
// certifiesTests: false
|
|
6
6
|
// certifiesFixpoint: false
|
|
7
7
|
// product = "brik64-cli"
|
|
8
|
-
// cli_version = "0.1.0-beta.
|
|
8
|
+
// cli_version = "0.1.0-beta.3"
|
|
9
9
|
// public_binary = "brik"
|
|
10
|
-
// execution_status = "
|
|
10
|
+
// execution_status = "public_beta"
|
|
11
11
|
// ascii_banner = "BRIK64"
|
|
12
12
|
// claim_boundary = "local_candidate_only"
|
|
13
13
|
|
package/pcd/cli_polymer.pcd
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
// certifiesTests: false
|
|
6
6
|
// certifiesFixpoint: false
|
|
7
7
|
// product = "brik64-cli"
|
|
8
|
-
// cli_version = "0.1.0-beta.
|
|
8
|
+
// cli_version = "0.1.0-beta.3"
|
|
9
9
|
// composition_kind = "polymer"
|
|
10
10
|
// source_units = "cli_core.pcd,cli_init_policy.pcd,cli_certify_emit.pcd"
|
|
11
11
|
// compile_status = "not_compiled"
|
package/src/brik.js
CHANGED
|
@@ -8,7 +8,7 @@ process.stdout.on('error', (error) => {
|
|
|
8
8
|
throw error;
|
|
9
9
|
});
|
|
10
10
|
|
|
11
|
-
const version = '0.1.0-beta.
|
|
11
|
+
const version = '0.1.0-beta.3';
|
|
12
12
|
const ascii = [
|
|
13
13
|
' ____ ____ ___ _ __ __ _ _ ',
|
|
14
14
|
'| __ )| _ \\|_ _| |/ // /_ | || |',
|
|
@@ -24,7 +24,7 @@ function sha256(value) {
|
|
|
24
24
|
function printBanner() {
|
|
25
25
|
process.stdout.write(`${ascii}\n`);
|
|
26
26
|
process.stdout.write(`BRIK64 CLI ${version}\n`);
|
|
27
|
-
process.stdout.write('status=
|
|
27
|
+
process.stdout.write('status=public_beta\n');
|
|
28
28
|
}
|
|
29
29
|
|
|
30
30
|
function help() {
|
|
@@ -35,6 +35,10 @@ function help() {
|
|
|
35
35
|
process.stdout.write(' emit <file.pcd> emit only when local certificate exists\n');
|
|
36
36
|
process.stdout.write(' --target <ts|rust|python> --out <dir> --tests\n');
|
|
37
37
|
process.stdout.write(' --version print version\n');
|
|
38
|
+
process.stdout.write('\nreferences:\n');
|
|
39
|
+
process.stdout.write(' docs https://docs.brik64.com/cli/install\n');
|
|
40
|
+
process.stdout.write(' skill https://github.com/brik64/brik64-tools-skills\n');
|
|
41
|
+
process.stdout.write(' pcd standard https://github.com/brik64/pcd-standard\n');
|
|
38
42
|
}
|
|
39
43
|
|
|
40
44
|
function readFileRequired(file) {
|