@aimlsuperagent/agent 0.1.1 → 0.1.2
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/DEPLOYMENT_LOG.md +23 -5
- package/README.md +7 -7
- package/REPO_SOURCE_OF_TRUTH.json +3 -3
- package/SECURITY.md +1 -2
- package/WORKING_NOTES.md +5 -6
- package/docs/04-verification-loop.md +1 -1
- package/docs/10-adoption-playbook.md +1 -1
- package/docs/npm-publishing.md +96 -0
- package/docs/release-checklist.md +3 -3
- package/package.json +3 -3
- package/docs/npm-private-publishing.md +0 -125
package/DEPLOYMENT_LOG.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Deployment Log
|
|
2
2
|
|
|
3
|
-
This repository is
|
|
3
|
+
This repository is public. The npm package is published publicly at `@aimlsuperagent/agent`.
|
|
4
4
|
|
|
5
5
|
## 2026-05-31 - Private Repository Buildout
|
|
6
6
|
|
|
@@ -27,7 +27,7 @@ Commit or build: pending
|
|
|
27
27
|
Change: Added MIT License and updated package metadata.
|
|
28
28
|
Verification: `node bin/aiml-superagent.js check . --release --strict`
|
|
29
29
|
Rollback: change `LICENSE` and `package.json` before public release if a different license is selected.
|
|
30
|
-
Risks:
|
|
30
|
+
Risks: MIT terms apply to public reuse.
|
|
31
31
|
|
|
32
32
|
## 2026-05-31 - Private npm Package Preparation
|
|
33
33
|
|
|
@@ -50,8 +50,26 @@ Risks: npm package metadata changes only become visible on npm after publishing
|
|
|
50
50
|
## 2026-06-01 - Trusted Publishing Workflow
|
|
51
51
|
|
|
52
52
|
Platform: GitHub Actions and npm
|
|
53
|
-
Commit or build:
|
|
53
|
+
Commit or build: `64dc17b`; GitHub Actions run `26748684943`
|
|
54
54
|
Change: Added `.github/workflows/npm-publish.yml` for npm Trusted Publishing with GitHub OIDC, `id-token: write`, Node 24, release readiness checks, and restricted npm publish.
|
|
55
|
-
Verification:
|
|
55
|
+
Verification: trusted publisher created for `marvinbfreedman/aimlsuperagent` and `npm-publish.yml`; workflow completed successfully; `npm view @aimlsuperagent/agent version repository.url bugs.url --json` reports version `0.1.1` with the Marvin Freedman repository URLs.
|
|
56
56
|
Rollback: remove the workflow file and publish manually with npm OTP or an npm token that npm accepts for package PUT writes.
|
|
57
|
-
Risks:
|
|
57
|
+
Risks: public package installs no longer require npm organization authorization.
|
|
58
|
+
|
|
59
|
+
## 2026-06-01 - Restricted npm Publish
|
|
60
|
+
|
|
61
|
+
Platform: npm
|
|
62
|
+
Commit or build: package version `0.1.1`
|
|
63
|
+
Change: Published `@aimlsuperagent/agent@0.1.1` from `marvinbfreedman/aimlsuperagent` through npm Trusted Publishing.
|
|
64
|
+
Verification: GitHub Actions run `26748684943` completed with `success`; npm metadata now shows repository `git+https://github.com/marvinbfreedman/aimlsuperagent.git` and bugs URL `https://github.com/marvinbfreedman/aimlsuperagent/issues`.
|
|
65
|
+
Rollback: publish a new patch version with corrected metadata or access policy; do not unpublish unless there is a security issue.
|
|
66
|
+
Risks: package remains private/restricted, so unauthorized users see npm `404`/access errors by design.
|
|
67
|
+
|
|
68
|
+
## 2026-06-01 - Public npm Access
|
|
69
|
+
|
|
70
|
+
Platform: npm and GitHub
|
|
71
|
+
Commit or build: pending
|
|
72
|
+
Change: Changed `@aimlsuperagent/agent` access from private/restricted to public. Confirmed `github.com/marvinbfreedman/aimlsuperagent` is public.
|
|
73
|
+
Verification: `npm access set status=public @aimlsuperagent/agent` returned `@aimlsuperagent/agent: public`; repository API reported `visibility: public`.
|
|
74
|
+
Rollback: npm public access can be changed back only deliberately with `npm access set status=private`; do not do that unless distribution should become private again.
|
|
75
|
+
Risks: package and repository are now available to the public, so all future docs and examples must stay secret-safe.
|
package/README.md
CHANGED
|
@@ -115,13 +115,13 @@ npm i -D @aimlsuperagent/agent
|
|
|
115
115
|
Copy the templates into a project:
|
|
116
116
|
|
|
117
117
|
```bash
|
|
118
|
-
npx
|
|
118
|
+
npx @aimlsuperagent/agent init .
|
|
119
119
|
```
|
|
120
120
|
|
|
121
121
|
Check a project for SuperAgent readiness:
|
|
122
122
|
|
|
123
123
|
```bash
|
|
124
|
-
npx
|
|
124
|
+
npx @aimlsuperagent/agent check .
|
|
125
125
|
```
|
|
126
126
|
|
|
127
127
|
For personal machine-wide use, install the CLI globally:
|
|
@@ -143,13 +143,13 @@ npm run pack:dry-run
|
|
|
143
143
|
Before making a repo public:
|
|
144
144
|
|
|
145
145
|
```bash
|
|
146
|
-
npx
|
|
146
|
+
npx @aimlsuperagent/agent check . --release
|
|
147
147
|
```
|
|
148
148
|
|
|
149
149
|
For CI where medium-risk findings should fail the build:
|
|
150
150
|
|
|
151
151
|
```bash
|
|
152
|
-
npx
|
|
152
|
+
npx @aimlsuperagent/agent check . --strict
|
|
153
153
|
```
|
|
154
154
|
|
|
155
155
|
## Package Analytics
|
|
@@ -245,7 +245,7 @@ The model can change. The operating discipline should remain stable.
|
|
|
245
245
|
2. Fill in production owners, deployment surfaces, package manager, test commands, and secret names.
|
|
246
246
|
3. Add `DEPLOYMENT_LOG.md` after the next live deploy.
|
|
247
247
|
4. Add incident reports only for issues that change future behavior.
|
|
248
|
-
5. Run `npx
|
|
248
|
+
5. Run `npx @aimlsuperagent/agent check`.
|
|
249
249
|
6. Iterate until the checker reports no high-risk gaps.
|
|
250
250
|
|
|
251
251
|
## Design Principles
|
|
@@ -272,11 +272,11 @@ See [docs/comparison-claude-md.md](docs/comparison-claude-md.md).
|
|
|
272
272
|
|
|
273
273
|
## Status
|
|
274
274
|
|
|
275
|
-
|
|
275
|
+
Public release candidate. The repository and npm package are public under the MIT License.
|
|
276
276
|
|
|
277
277
|
Package name: `@aimlsuperagent/agent`.
|
|
278
278
|
|
|
279
|
-
|
|
279
|
+
Install globally with `npm i -g @aimlsuperagent/agent`, or run directly with `npx @aimlsuperagent/agent`. See [docs/npm-publishing.md](docs/npm-publishing.md).
|
|
280
280
|
|
|
281
281
|
## License
|
|
282
282
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"project": {
|
|
4
4
|
"name": "AiML SuperAgent",
|
|
5
5
|
"purpose": "A token-efficient operating framework for AI coding assistants.",
|
|
6
|
-
"status": "
|
|
6
|
+
"status": "public-release-candidate",
|
|
7
7
|
"primaryAudience": [
|
|
8
8
|
"software teams using AI coding assistants",
|
|
9
9
|
"solo builders managing long-running projects",
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
"templates": "templates/",
|
|
17
17
|
"docs": "docs/",
|
|
18
18
|
"examples": "examples/",
|
|
19
|
-
"
|
|
19
|
+
"npmPublishing": "docs/npm-publishing.md"
|
|
20
20
|
},
|
|
21
21
|
"contextMinimizer": {
|
|
22
22
|
"readFirst": [
|
|
@@ -57,7 +57,7 @@
|
|
|
57
57
|
"all templates are copy-safe",
|
|
58
58
|
"checker passes",
|
|
59
59
|
"README links resolve",
|
|
60
|
-
"npm
|
|
60
|
+
"npm public access confirmed before publishing"
|
|
61
61
|
]
|
|
62
62
|
},
|
|
63
63
|
"secrets": {
|
package/SECURITY.md
CHANGED
|
@@ -6,7 +6,7 @@ AiML SuperAgent is designed around secret-safe operation.
|
|
|
6
6
|
|
|
7
7
|
Do not open public issues containing secrets.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Use the repository security contact or private advisory flow for sensitive reports.
|
|
10
10
|
|
|
11
11
|
## Secret Policy
|
|
12
12
|
|
|
@@ -29,4 +29,3 @@ Run before release:
|
|
|
29
29
|
```bash
|
|
30
30
|
npm run check
|
|
31
31
|
```
|
|
32
|
-
|
package/WORKING_NOTES.md
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
## Current State
|
|
4
4
|
|
|
5
|
-
- Repository is
|
|
6
|
-
- npm package is `@aimlsuperagent/agent
|
|
7
|
-
- Goal is a public
|
|
5
|
+
- Repository is public at `github.com/marvinbfreedman/aimlsuperagent`.
|
|
6
|
+
- npm package is public at `@aimlsuperagent/agent`.
|
|
7
|
+
- Goal is a public release candidate for AiML SuperAgent.
|
|
8
8
|
- Positioning: not a replacement for behavior files, but the next operating layer after them.
|
|
9
9
|
- Core differentiator: Context Minimizer, which reduces token waste by separating durable memory from active task context.
|
|
10
10
|
- Checker now validates unresolved placeholders, source-of-truth paths, context-bloat size limits, and optional release/strict gates.
|
|
@@ -19,11 +19,10 @@
|
|
|
19
19
|
|
|
20
20
|
## Open Decisions
|
|
21
21
|
|
|
22
|
-
- Whether to make the npm package public after private-package testing is complete.
|
|
23
22
|
- Whether to add model-specific adapter files for Claude, Codex, Cursor, and Gemini in separate folders.
|
|
24
23
|
|
|
25
24
|
## Decisions
|
|
26
25
|
|
|
27
|
-
- License set to MIT
|
|
26
|
+
- License set to MIT for public reuse.
|
|
28
27
|
- Package metadata points at `github.com/marvinbfreedman/aimlsuperagent`.
|
|
29
|
-
- npm
|
|
28
|
+
- npm package public access is confirmed for `@aimlsuperagent/agent`.
|
|
@@ -0,0 +1,96 @@
|
|
|
1
|
+
# npm Publishing
|
|
2
|
+
|
|
3
|
+
This repository publishes a public npm package named:
|
|
4
|
+
|
|
5
|
+
```text
|
|
6
|
+
@aimlsuperagent/agent
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
The package is public. Anyone can install it from the npm registry without joining the `aimlsuperagent` npm organization.
|
|
10
|
+
|
|
11
|
+
## Current Publish State
|
|
12
|
+
|
|
13
|
+
`package.json` includes:
|
|
14
|
+
|
|
15
|
+
```json
|
|
16
|
+
"publishConfig": {
|
|
17
|
+
"access": "public",
|
|
18
|
+
"registry": "https://registry.npmjs.org/"
|
|
19
|
+
}
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Public access is intentional for the scoped package.
|
|
23
|
+
|
|
24
|
+
## Confirm Current Access
|
|
25
|
+
|
|
26
|
+
Check package visibility:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
npm access get status @aimlsuperagent/agent
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
Expected current shape:
|
|
33
|
+
|
|
34
|
+
- package status: `public`
|
|
35
|
+
- package name: `@aimlsuperagent/agent`
|
|
36
|
+
- repository: `github.com/marvinbfreedman/aimlsuperagent`
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
npm i -g @aimlsuperagent/agent
|
|
40
|
+
aiml-superagent --help
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## Dry Run
|
|
44
|
+
|
|
45
|
+
Run:
|
|
46
|
+
|
|
47
|
+
```bash
|
|
48
|
+
npm run check:release
|
|
49
|
+
npm run pack:dry-run
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
Review the file list. It should include docs, templates, examples, schemas, the CLI, and root operating files. It should not include secrets, local logs, or build output.
|
|
53
|
+
|
|
54
|
+
## Publishing Procedure
|
|
55
|
+
|
|
56
|
+
For a new public version:
|
|
57
|
+
|
|
58
|
+
1. Bump the package version.
|
|
59
|
+
2. Run:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
npm run check:release
|
|
63
|
+
npm run pack:dry-run
|
|
64
|
+
npm publish --access public
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Trusted Publishing
|
|
68
|
+
|
|
69
|
+
npm recommends Trusted Publishing for automation and CI/CD. This repository includes:
|
|
70
|
+
|
|
71
|
+
```text
|
|
72
|
+
.github/workflows/npm-publish.yml
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
Trusted Publishing is configured for this package:
|
|
76
|
+
|
|
77
|
+
- Provider: GitHub Actions
|
|
78
|
+
- Organization or user: `marvinbfreedman`
|
|
79
|
+
- Repository: `aimlsuperagent`
|
|
80
|
+
- Workflow filename: `npm-publish.yml`
|
|
81
|
+
- Allowed action: `npm publish`
|
|
82
|
+
|
|
83
|
+
Use GitHub Actions > Publish npm package > Run workflow. The workflow uses GitHub OIDC instead of a long-lived `NPM_TOKEN`.
|
|
84
|
+
|
|
85
|
+
## Install
|
|
86
|
+
|
|
87
|
+
Anyone can install globally:
|
|
88
|
+
|
|
89
|
+
```bash
|
|
90
|
+
npm i -g @aimlsuperagent/agent
|
|
91
|
+
aiml-superagent --help
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
## Failure Rule
|
|
95
|
+
|
|
96
|
+
If `npm run check:release` or `npm run pack:dry-run` fails, do not publish. Fix the release blocker first.
|
|
@@ -34,12 +34,12 @@ Optional:
|
|
|
34
34
|
mkdir -p /tmp/superagent-smoke
|
|
35
35
|
cd /tmp/superagent-smoke
|
|
36
36
|
npm i -D @aimlsuperagent/agent
|
|
37
|
-
npx
|
|
38
|
-
npx
|
|
37
|
+
npx @aimlsuperagent/agent init .
|
|
38
|
+
npx @aimlsuperagent/agent check .
|
|
39
39
|
```
|
|
40
40
|
|
|
41
41
|
## Publication
|
|
42
42
|
|
|
43
43
|
- Confirm MIT License is still the intended public license.
|
|
44
|
-
- Remove
|
|
44
|
+
- Remove stale pre-publication wording if appropriate.
|
|
45
45
|
- Tag first public release.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aimlsuperagent/agent",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "A token-efficient operating framework for AI coding assistants.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -28,7 +28,7 @@
|
|
|
28
28
|
"check:json": "node bin/aiml-superagent.js check . --json",
|
|
29
29
|
"check:release": "node bin/aiml-superagent.js check . --release --strict",
|
|
30
30
|
"pack:dry-run": "npm pack --dry-run --cache ./.npm-cache",
|
|
31
|
-
"prepublishOnly": "node scripts/assert-
|
|
31
|
+
"prepublishOnly": "node scripts/assert-public-publish-ready.js && node bin/aiml-superagent.js check . --release --strict"
|
|
32
32
|
},
|
|
33
33
|
"keywords": [
|
|
34
34
|
"ai",
|
|
@@ -50,7 +50,7 @@
|
|
|
50
50
|
"node": ">=18"
|
|
51
51
|
},
|
|
52
52
|
"publishConfig": {
|
|
53
|
-
"access": "
|
|
53
|
+
"access": "public",
|
|
54
54
|
"registry": "https://registry.npmjs.org/"
|
|
55
55
|
},
|
|
56
56
|
"license": "MIT"
|
|
@@ -1,125 +0,0 @@
|
|
|
1
|
-
# Private npm Publishing
|
|
2
|
-
|
|
3
|
-
This repository is prepared for a private npm package named:
|
|
4
|
-
|
|
5
|
-
```text
|
|
6
|
-
@aimlsuperagent/agent
|
|
7
|
-
```
|
|
8
|
-
|
|
9
|
-
The package is currently published as a private/restricted npm package. Users who are not authenticated and authorized will see npm `404 Not Found` errors that can look like the package or organization does not exist.
|
|
10
|
-
|
|
11
|
-
## Current Safety State
|
|
12
|
-
|
|
13
|
-
`package.json` includes:
|
|
14
|
-
|
|
15
|
-
```json
|
|
16
|
-
"publishConfig": {
|
|
17
|
-
"access": "restricted",
|
|
18
|
-
"registry": "https://registry.npmjs.org/"
|
|
19
|
-
}
|
|
20
|
-
```
|
|
21
|
-
|
|
22
|
-
Restricted access is the npm setting required for a private scoped package.
|
|
23
|
-
|
|
24
|
-
## Confirm Current Access
|
|
25
|
-
|
|
26
|
-
Log in:
|
|
27
|
-
|
|
28
|
-
```bash
|
|
29
|
-
npm login
|
|
30
|
-
npm whoami
|
|
31
|
-
```
|
|
32
|
-
|
|
33
|
-
Check organization or scope access:
|
|
34
|
-
|
|
35
|
-
```bash
|
|
36
|
-
npm org ls aimlsuperagent
|
|
37
|
-
npm team ls aimlsuperagent
|
|
38
|
-
npm team ls aimlsuperagent:developers
|
|
39
|
-
npm access get status @aimlsuperagent/agent
|
|
40
|
-
npm access list packages aimlsuperagent:developers
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
Expected current shape:
|
|
44
|
-
|
|
45
|
-
- package status: `private`
|
|
46
|
-
- org owner: `aimlnexus`
|
|
47
|
-
- install team: `aimlsuperagent:developers`
|
|
48
|
-
- team package access: `@aimlsuperagent/agent` read-only
|
|
49
|
-
|
|
50
|
-
## Add A Private Package User
|
|
51
|
-
|
|
52
|
-
Use the person's npm username, not their email address.
|
|
53
|
-
|
|
54
|
-
```bash
|
|
55
|
-
npm org set aimlsuperagent npm_username developer
|
|
56
|
-
npm team add aimlsuperagent:developers npm_username
|
|
57
|
-
```
|
|
58
|
-
|
|
59
|
-
The user must accept the npm organization invite, then run:
|
|
60
|
-
|
|
61
|
-
```bash
|
|
62
|
-
npm login
|
|
63
|
-
npm i -g @aimlsuperagent/agent
|
|
64
|
-
aiml-superagent --help
|
|
65
|
-
```
|
|
66
|
-
|
|
67
|
-
If they still see `404 Not Found`, they are either not logged in, have not accepted the org invite, are not in the `developers` team, or are using a different npm registry.
|
|
68
|
-
|
|
69
|
-
## Dry Run
|
|
70
|
-
|
|
71
|
-
Run:
|
|
72
|
-
|
|
73
|
-
```bash
|
|
74
|
-
npm run check:release
|
|
75
|
-
npm run pack:dry-run
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
Review the file list. It should include docs, templates, examples, schemas, the CLI, and root operating files. It should not include secrets, local logs, or build output.
|
|
79
|
-
|
|
80
|
-
## Publishing Procedure
|
|
81
|
-
|
|
82
|
-
For a new private version:
|
|
83
|
-
|
|
84
|
-
1. Bump the package version.
|
|
85
|
-
2. Run:
|
|
86
|
-
|
|
87
|
-
```bash
|
|
88
|
-
npm run check:release
|
|
89
|
-
npm run pack:dry-run
|
|
90
|
-
npm publish --access restricted
|
|
91
|
-
```
|
|
92
|
-
|
|
93
|
-
Do not run `npm publish --access public`.
|
|
94
|
-
|
|
95
|
-
## Trusted Publishing
|
|
96
|
-
|
|
97
|
-
npm recommends Trusted Publishing for automation and CI/CD. This repository includes:
|
|
98
|
-
|
|
99
|
-
```text
|
|
100
|
-
.github/workflows/npm-publish.yml
|
|
101
|
-
```
|
|
102
|
-
|
|
103
|
-
Configure the trusted publisher in npm package settings:
|
|
104
|
-
|
|
105
|
-
- Provider: GitHub Actions
|
|
106
|
-
- Organization or user: `marvinbfreedman`
|
|
107
|
-
- Repository: `aimlsuperagent`
|
|
108
|
-
- Workflow filename: `npm-publish.yml`
|
|
109
|
-
- Allowed action: `npm publish`
|
|
110
|
-
|
|
111
|
-
After that, use GitHub Actions > Publish npm package > Run workflow. The workflow uses GitHub OIDC instead of a long-lived `NPM_TOKEN`.
|
|
112
|
-
|
|
113
|
-
## Install
|
|
114
|
-
|
|
115
|
-
Authorized users can install globally:
|
|
116
|
-
|
|
117
|
-
```bash
|
|
118
|
-
npm login
|
|
119
|
-
npm i -g @aimlsuperagent/agent
|
|
120
|
-
aiml-superagent --help
|
|
121
|
-
```
|
|
122
|
-
|
|
123
|
-
## Failure Rule
|
|
124
|
-
|
|
125
|
-
If npm cannot confirm restricted/private access, do not publish. Keep using the private GitHub repo or a private tarball.
|