aienvmp 0.1.21 → 0.1.22

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/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.1.22
4
+
5
+ - Reworked the README around Quick Start, AI Usage, CI Usage, and outputs.
6
+ - Made the project positioning clearer: AI-first environment maps for shared coding machines.
7
+ - Emphasized read-only planning and avoiding runtime/tool drift across agents.
8
+
3
9
  ## 0.1.21
4
10
 
5
11
  - Added a GitHub Actions artifact upload example for `AIENV.md`, plan outputs, manifest, and dashboard.
package/README.md CHANGED
@@ -6,29 +6,39 @@
6
6
 
7
7
  **AI Environment Map.**
8
8
 
9
- `aienvmp` is an AI environment coordination tool for shared coding machines.
9
+ `aienvmp` is an AI-first environment map for shared coding machines.
10
10
 
11
- It helps Codex, Claude, Gemini, and other agents avoid silently using or installing different runtime and tool versions.
11
+ It helps Codex, Claude, Gemini, and humans avoid silent Node, Python, package manager, Docker, and security drift.
12
12
 
13
- Core loop: scan the env, give AI a preflight context, and hand off safe next steps to the next agent.
13
+ Core loop: scan once, give AI a preflight context, write a read-only action plan, and hand off safe next steps.
14
14
 
15
- ## Use
15
+ ## Quick Start
16
16
 
17
17
  ```bash
18
18
  npx aienvmp sync
19
19
  npx aienvmp context
20
20
  npx aienvmp plan
21
21
  npx aienvmp handoff
22
- npx aienvmp handoff --record --actor agent:codex
23
22
  ```
24
23
 
25
- Optional read-only checks:
24
+ Optional deeper read-only checks:
26
25
 
27
26
  ```bash
28
27
  npx aienvmp sync --deep
29
28
  npx aienvmp sync --security
30
29
  ```
31
30
 
31
+ ## AI Usage
32
+
33
+ Tell each agent to read `aienvmp context --json` before environment changes.
34
+
35
+ ```bash
36
+ npx aienvmp context --json
37
+ npx aienvmp intent --actor agent:codex --action "upgrade node" --target node
38
+ npx aienvmp record --actor agent:codex --summary "updated .nvmrc" --target node
39
+ npx aienvmp handoff --record --actor agent:codex
40
+ ```
41
+
32
42
  ## Output
33
43
 
34
44
  ```text
@@ -45,7 +55,7 @@ Trust states are machine-readable: `observed`, `planned`, `changed`, `review`, `
45
55
 
46
56
  AI agents can observe, plan, and record. Only a human or CI should mark environment facts as verified.
47
57
 
48
- ## For AGENTS.md
58
+ ## Agent Files
49
59
 
50
60
  `aienvmp` does not replace AGENTS.md. It gives AGENTS.md a live environment source of truth.
51
61
 
@@ -53,10 +63,17 @@ AI agents can observe, plan, and record. Only a human or CI should mark environm
53
63
  npx aienvmp snippet agents
54
64
  ```
55
65
 
56
- ## CI
66
+ ## CI Usage
57
67
 
58
68
  Use the GitHub Action to write the env map, plan, dashboard, and optional strict checks. See [examples/github-action.yml](examples/github-action.yml).
59
69
 
70
+ ```yaml
71
+ - uses: soovwv/aienvmp@main
72
+ with:
73
+ write-plan: "true"
74
+ strict: "off" # security, policy, coordination, all, or off
75
+ ```
76
+
60
77
  ## Commands
61
78
 
62
79
  ```bash
@@ -76,6 +93,7 @@ aienvmp doctor --strict security # fail only scoped warnings
76
93
  - simple by default
77
94
  - AI-first
78
95
  - lightweight
96
+ - read-only planning, no automatic fixes
79
97
  - one advisory engine, optional enforcement with `doctor --ci`
80
98
  - scoped enforcement with `doctor --strict security|policy|coordination|all`
81
99
  - non-blocking unless strict mode is explicitly requested
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "aienvmp",
3
- "version": "0.1.21",
3
+ "version": "0.1.22",
4
4
  "description": "AI-first environment maps and lightweight runtime SBOMs for shared development machines.",
5
5
  "type": "module",
6
6
  "bin": {