@brik64/cli 0.1.0-beta.1 → 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/LICENSE +70 -5
- package/NOTICE +9 -8
- package/README.md +169 -9
- 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 +16 -5
- 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 +64 -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/LICENSE
CHANGED
|
@@ -1,6 +1,71 @@
|
|
|
1
|
-
|
|
1
|
+
BRIK64 CLI PUBLIC BETA EVALUATION LICENSE
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
3
|
+
Copyright (c) 2026 BRIK64 INC. All rights reserved.
|
|
4
|
+
|
|
5
|
+
This package, including the BRIK64 CLI source, bundled PCD seed material,
|
|
6
|
+
examples, package metadata, documentation, evidence artifacts, and release
|
|
7
|
+
materials, is proprietary software and confidential know-how of BRIK64 INC
|
|
8
|
+
except where a file explicitly states otherwise.
|
|
9
|
+
|
|
10
|
+
1. Evaluation Permission
|
|
11
|
+
|
|
12
|
+
BRIK64 INC grants you a limited, revocable, non-exclusive, non-transferable
|
|
13
|
+
permission to download, install, and run this public beta release only for
|
|
14
|
+
internal evaluation, local workflow testing, compatibility review, and feedback
|
|
15
|
+
to BRIK64.
|
|
16
|
+
|
|
17
|
+
2. Reserved Rights
|
|
18
|
+
|
|
19
|
+
BRIK64 INC reserves all rights not expressly granted in this license. This
|
|
20
|
+
license does not grant any ownership interest, patent license, trademark license,
|
|
21
|
+
commercial distribution right, sublicensing right, hosted service right, resale
|
|
22
|
+
right, or right to create derivative works for public or commercial use.
|
|
23
|
+
|
|
24
|
+
3. Restrictions
|
|
25
|
+
|
|
26
|
+
Without prior written permission from BRIK64 INC, you may not:
|
|
27
|
+
|
|
28
|
+
- redistribute, mirror, sell, sublicense, rent, lease, or commercially exploit
|
|
29
|
+
this software;
|
|
30
|
+
- publish modified versions or derivative works;
|
|
31
|
+
- remove copyright, trademark, provenance, release, checksum, or evidence
|
|
32
|
+
notices;
|
|
33
|
+
- use BRIK64 names, logos, marks, or release artifacts to imply endorsement or
|
|
34
|
+
certification;
|
|
35
|
+
- use the beta in regulated, safety-critical, mission-critical, or production
|
|
36
|
+
systems as a certification authority.
|
|
37
|
+
|
|
38
|
+
4. Beta Scope
|
|
39
|
+
|
|
40
|
+
This public beta is provided for evaluation of local BRIK64 CLI workflows,
|
|
41
|
+
PCD-oriented project structure, package validation, and bounded evidence review.
|
|
42
|
+
Expanded platform support, production certification surfaces, and advanced
|
|
43
|
+
compiler-methodology scopes are governed by BRIK64 release gates and written
|
|
44
|
+
commercial terms.
|
|
45
|
+
|
|
46
|
+
5. Feedback
|
|
47
|
+
|
|
48
|
+
If you provide feedback, bug reports, ideas, or suggestions to BRIK64, you grant
|
|
49
|
+
BRIK64 INC a perpetual, irrevocable, worldwide, royalty-free right to use that
|
|
50
|
+
feedback to improve BRIK64 products and services without obligation to you.
|
|
51
|
+
|
|
52
|
+
6. No Warranty
|
|
53
|
+
|
|
54
|
+
This beta is provided as-is for evaluation. BRIK64 INC disclaims all warranties,
|
|
55
|
+
express or implied, including merchantability, fitness for a particular purpose,
|
|
56
|
+
non-infringement, and uninterrupted or error-free operation.
|
|
57
|
+
|
|
58
|
+
7. Limitation Of Liability
|
|
59
|
+
|
|
60
|
+
To the maximum extent permitted by law, BRIK64 INC is not liable for indirect,
|
|
61
|
+
incidental, special, consequential, exemplary, punitive, or business interruption
|
|
62
|
+
damages arising from this beta, even if advised of the possibility of such
|
|
63
|
+
damages.
|
|
64
|
+
|
|
65
|
+
8. Commercial Licensing
|
|
66
|
+
|
|
67
|
+
For production, commercial, hosted, redistribution, partner, enterprise,
|
|
68
|
+
regulated, or certification-oriented use, contact BRIK64 INC through the public
|
|
69
|
+
company channels listed at https://brik64.com.
|
|
70
|
+
|
|
71
|
+
This is not an open source license.
|
package/NOTICE
CHANGED
|
@@ -2,16 +2,17 @@ BRIK64 CLI Public Beta Notice
|
|
|
2
2
|
|
|
3
3
|
Copyright (c) 2026 BRIK64 INC. All rights reserved.
|
|
4
4
|
|
|
5
|
-
BRIK64 CLI 0.1 public beta is
|
|
6
|
-
bounded evidence review, and claim-safe project scaffolding.
|
|
7
|
-
beta surface is focused on macOS local CLI usage, package
|
|
8
|
-
versioned release evidence. Expanded platform support and
|
|
9
|
-
surfaces remain
|
|
5
|
+
BRIK64 CLI 0.1 public beta is proprietary software published for evaluation of
|
|
6
|
+
local PCD workflows, bounded evidence review, and claim-safe project scaffolding.
|
|
7
|
+
The current public beta surface is focused on macOS local CLI usage, package
|
|
8
|
+
validation, and versioned release evidence. Expanded platform support and
|
|
9
|
+
stronger certification surfaces remain governed by the BRIK64 evidence process
|
|
10
|
+
and commercial licensing terms.
|
|
10
11
|
|
|
11
|
-
Public product information: https://brik64.com
|
|
12
|
+
Public product information: https://brik64.com
|
|
12
13
|
Documentation: https://docs.brik64.com/cli/install
|
|
13
14
|
Repository: https://github.com/brik64/brik64-cli
|
|
14
15
|
Package: https://www.npmjs.com/package/@brik64/cli
|
|
15
16
|
|
|
16
|
-
|
|
17
|
-
license
|
|
17
|
+
License: BRIK64 CLI Public Beta Evaluation License. This is not an open source
|
|
18
|
+
license. See LICENSE for evaluation terms and reserved rights.
|
package/README.md
CHANGED
|
@@ -1,5 +1,18 @@
|
|
|
1
1
|
# BRIK64 CLI
|
|
2
2
|
|
|
3
|
+
```text
|
|
4
|
+
╔══════════════════════════════════════════════════════╗
|
|
5
|
+
║ ║
|
|
6
|
+
║ ██████╗ ██████╗ ██╗██╗ ██╗ ██████╗ ██╗ ██╗ ║
|
|
7
|
+
║ ██╔══██╗██╔══██╗ ██║██║ ██╔╝██╔════╝ ██║ ██║ ║
|
|
8
|
+
║ ██████╔╝██████╔╝ ██║█████╔╝ ███████╗ ███████║ ║
|
|
9
|
+
║ ██╔══██╗██╔══██╗ ██║██╔═██╗ ██╔═══██╗╚════██║ ║
|
|
10
|
+
║ ██████╔╝██║ ██║ ██║██║ ██╗╚██████╔╝ ██║ ║
|
|
11
|
+
║ ╚═════╝ ╚═╝ ╚═╝ ╚═╝╚═╝ ╚═╝ ╚═════╝ ╚═╝ ║
|
|
12
|
+
║ ║
|
|
13
|
+
╚══════════════════════════════════════════════════════╝
|
|
14
|
+
```
|
|
15
|
+
|
|
3
16
|
BRIK64 CLI is the public beta command-line surface for local BRIK64 project
|
|
4
17
|
workflows. It gives developers a practical way to start working with
|
|
5
18
|
PCD-oriented structure, local evidence review, and claim-safe project scaffolding
|
|
@@ -7,11 +20,65 @@ from their own machine.
|
|
|
7
20
|
|
|
8
21
|
Generated code is easy to ship. Trust is the harder part. BRIK64 CLI is built
|
|
9
22
|
for teams that want software work to carry clearer structure, repeatable
|
|
10
|
-
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.
|
|
11
78
|
|
|
12
79
|
## Status
|
|
13
80
|
|
|
14
|
-
Current beta: `0.1.0-beta.1
|
|
81
|
+
Current beta: [`0.1.0-beta.3`](https://github.com/brik64/brik64-cli/releases/tag/v0.1.0-beta.3)
|
|
15
82
|
|
|
16
83
|
This beta is intended for evaluation, local workflow trials, package smoke
|
|
17
84
|
testing, and bounded PCD/evidence review. The current public beta surface is
|
|
@@ -37,9 +104,47 @@ brik --version
|
|
|
37
104
|
brik help
|
|
38
105
|
```
|
|
39
106
|
|
|
40
|
-
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.
|
|
126
|
+
|
|
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
|
+
```
|
|
41
143
|
|
|
42
|
-
|
|
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.
|
|
43
148
|
|
|
44
149
|
## What It Does
|
|
45
150
|
|
|
@@ -51,26 +156,81 @@ Docs: https://docs.brik64.com/cli/install
|
|
|
51
156
|
- Establishes the public package surface for controlled CLI evaluation and future
|
|
52
157
|
SDK alignment.
|
|
53
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
|
+
|
|
54
184
|
## Current Scope
|
|
55
185
|
|
|
56
|
-
The `0.1.0-beta.
|
|
186
|
+
The `0.1.0-beta.3` release is scoped to public beta evaluation. It is centered
|
|
57
187
|
on local developer workflow, macOS package validation, PCD seed material, and
|
|
58
188
|
release evidence review. Production certification, expanded platform support,
|
|
59
189
|
and advanced compiler-methodology claims are promoted only when the matching
|
|
60
190
|
BRIK64 gates and evidence packs authorize that scope.
|
|
61
191
|
|
|
192
|
+
|
|
193
|
+
## Release Assets
|
|
194
|
+
|
|
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:
|
|
206
|
+
|
|
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).
|
|
209
|
+
|
|
210
|
+
Planned release lanes:
|
|
211
|
+
|
|
212
|
+
- macOS Intel package after platform-specific package and smoke gates pass.
|
|
213
|
+
- Debian/Ubuntu Linux packages after distro-specific build and install gates pass.
|
|
214
|
+
- Windows PC package after Windows runner validation and install smoke pass.
|
|
215
|
+
|
|
216
|
+
Each platform package should ship with its own artifact, checksum, install smoke,
|
|
217
|
+
and release evidence before it is promoted on npm, GitHub Releases, docs, or
|
|
218
|
+
brik64.com.
|
|
219
|
+
|
|
62
220
|
## Release Evidence
|
|
63
221
|
|
|
64
222
|
The public beta package is tied to versioned release artifacts, checksums, and
|
|
65
223
|
operator gates. Use the GitHub release assets and checksums to review the exact
|
|
66
224
|
package candidate before treating any install path as authoritative.
|
|
67
225
|
|
|
68
|
-
GitHub release:
|
|
226
|
+
GitHub release:
|
|
227
|
+
[v0.1.0-beta.3](https://github.com/brik64/brik64-cli/releases/tag/v0.1.0-beta.3)
|
|
69
228
|
|
|
70
229
|
## Copyright And License
|
|
71
230
|
|
|
72
231
|
Copyright (c) 2026 BRIK64 INC. All rights reserved.
|
|
73
232
|
|
|
74
|
-
See
|
|
75
|
-
|
|
76
|
-
|
|
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
|
|
|
@@ -35,7 +45,7 @@ The workflow:
|
|
|
35
45
|
- requires `README.md` and `NOTICE`;
|
|
36
46
|
- fails if the version already exists on npm;
|
|
37
47
|
- publishes with public access and the selected dist-tag;
|
|
38
|
-
- verifies npm version metadata and dist-tag after publish.
|
|
48
|
+
- verifies npm version metadata, README filename/content metadata, tarball metadata, and dist-tag after publish. The workflow retries metadata reads because npm propagation can lag immediately after a successful publish.
|
|
39
49
|
|
|
40
50
|
## Trusted Publishing Upgrade
|
|
41
51
|
|
|
@@ -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.
|