avorelo 0.3.4 → 0.3.6

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.
Files changed (3) hide show
  1. package/README.md +37 -55
  2. package/dist/avorelo.mjs +3297 -750
  3. package/package.json +8 -3
package/README.md CHANGED
@@ -4,92 +4,74 @@
4
4
  work focused, keeps secrets out of the model and out of cloud, and saves proof of what actually happened,
5
5
  locally.
6
6
 
7
- > Status: **private alpha** (`0.2.0`). Local-first and deterministic. See the limitations below.
7
+ > Version: `0.3.4`. Local-first and deterministic.
8
8
 
9
9
  ## Quickstart
10
10
 
11
- No signup, no cloud account, no credentials, no network required.
11
+ **Recommended: copy the agent prompt.** Visit [avorelo.com](https://avorelo.com), click **Start with AI**, and copy the agent prompt into Claude Code, Codex, or Cursor. The agent handles activation safely.
12
+
13
+ **Local activation (no account needed):**
12
14
 
13
15
  ```
14
- npx avorelo@latest activate # detect your project, set up local state, start getting value
15
- npx avorelo@latest status # what's the workspace state? what's next?
16
- npx avorelo@latest run "run tests" # run your first focused task
17
- npx avorelo@latest control-center # read-only local operator view
16
+ npx -y avorelo@latest activate --scope project-wide
18
17
  ```
19
18
 
20
- Run `npx avorelo@latest activate` to start with the latest validated Avorelo CLI.
21
- Global install: `npm install -g avorelo` — then run `avorelo doctor` to check for updates.
19
+ **Account-linked activation (requires dashboard claim):**
22
20
 
23
- `activate` writes only local metadata under `.avorelo/` (gitignored) — no source, env, or secrets.
24
- `status` always tells you the next command. `readiness` is the *canonical phase gate* (most meaningful
25
- against the Avorelo repo itself); `status` is the per-workspace readiness signal for your own repo.
21
+ ```
22
+ npx -y avorelo@latest activate --scope project-wide --claim <activation_claim>
23
+ ```
26
24
 
27
- ## What it does
25
+ Generate a short-lived claim from your [dashboard](https://avorelo.com/dashboard). Claims expire in 15 minutes.
28
26
 
29
- One command starts a focused session and runs a coherent, local-first flow:
27
+ **Other commands:**
30
28
 
31
29
  ```
32
- avorelo run "fix the login redirect bug in src/auth" --target .
30
+ npx avorelo@latest status # workspace state and next step
31
+ npx avorelo@latest doctor # health check
32
+ npx avorelo@latest preflight # diagnose environment before activating
33
33
  ```
34
34
 
35
- That single command:
35
+ `activate` writes only local metadata under `.avorelo/` (gitignored) — no source, env, or secrets.
36
+
37
+ ## What it does
36
38
 
37
- 1. **Routes** the task through a deterministic **Secret Boundary** — a pasted credential is detected and
38
- never printed, persisted, or sent to the model; an unsafe task is blocked.
39
- 2. Starts a **session** around whatever AI coding tool you already use.
40
- 3. Compiles a **bounded, source-aware context** (references, never raw dumps).
41
- 4. Carries forward **next-run continuity** so the next session resumes safely.
42
- 5. Records **token & cost evidence** — honestly labelled `measured` / `imported` / `estimated` /
43
- `inferred` / `unavailable`. Unavailable is never reported as zero, and numbers are never fabricated.
44
- 6. Builds a **proof report** — savings are **refused** unless there is comparative evidence to back them.
45
- 7. Updates a **value ledger** of compact, confidence-labelled cards.
46
- 8. Prepares a **sanitized metadata sync** — **dry-run only**, local queue, no network.
39
+ Avorelo automates the operational layer around AI coding sessions:
47
40
 
48
- Everything is written locally under `.avorelo/`. See it all in one read-only view:
41
+ - **Context** — compiles bounded, source-aware context automatically
42
+ - **Routing** — picks the right model and workflow for the task
43
+ - **Scope** — enforces boundaries on what agents should touch
44
+ - **Safety** — catches drift, risky edits, and unbounded runs; blocks secret leakage
45
+ - **Proof** — creates local receipts of what changed and why
46
+ - **Handoff** — moves work cleanly between sessions and tools
49
47
 
50
- ```
51
- avorelo control-center --target .
52
- ```
48
+ Works with Claude Code, Codex, Cursor, and other AI coding tools. Runs locally. No workflow switch required.
53
49
 
54
- ## Other commands
50
+ ## Commands
55
51
 
56
52
  | Command | What it does |
57
53
  |---|---|
58
- | `avorelo run "<task>"` | The runtime product flow above |
59
- | `avorelo control-center` | Read-only local view of all session/proof/value state |
60
- | `avorelo open` | Local receipts dashboard (HTML/text/json) |
61
- | `avorelo readiness` | Canonical readiness gate for this workspace |
62
- | `avorelo secret-boundary scan` | Detect + redact secrets in content (local, no network) |
63
- | `avorelo context compile "<task>"` | Show the bounded context packet |
64
- | `avorelo report build` · `avorelo value cards` | Proof report · value cards |
65
- | `avorelo loop check "<task>"` | Pre-flight readiness check for AI loop |
66
- | `avorelo loop start "<task>"` | Start a bounded AI loop |
67
- | `avorelo loop latest` | Show the most recent loop result |
68
- | `avorelo loop resume` | Display continuation plan for latest loop |
69
- | `avorelo loop doctor` | Check environment readiness for looping |
70
- | `avorelo --version` · `avorelo --help` | Version · full command list |
54
+ | `avorelo activate` | Detect workspace, set up local state, verify setup |
55
+ | `avorelo status` | Current workspace state and next step |
56
+ | `avorelo doctor` | Health check |
57
+ | `avorelo preflight` | Environment diagnostics before activation |
58
+ | `avorelo run "<task>"` | Focused session with context, scope, and proof |
59
+ | `avorelo open` | Local receipts dashboard |
60
+ | `avorelo readiness` | Canonical readiness gate |
61
+ | `avorelo --version` | Version |
71
62
 
72
63
  ## Principles
73
64
 
74
- - **Local-first.** No login and no network are required to run the core flow. Only sanitized **metadata
75
- projections** are ever eligible for cloud sync, and v1 ships dry-run only.
76
- - **Secrets stay out.** Detection happens before context, redaction before the model, blocking before an
77
- unsafe action. Durable artifacts hold safe references, never raw secret values.
78
- - **Evidence over assertion.** Confidence labels are mandatory; savings are refused without evidence;
79
- "done" requires real proof, not a label.
65
+ - **Local-first.** No login and no network required for core activation. Cloud sync is opt-in and claim-based.
66
+ - **Secrets stay out.** Detection before context, redaction before the model, blocking before unsafe action.
67
+ - **Evidence over assertion.** Confidence labels are mandatory; savings are refused without evidence.
80
68
 
81
69
  ## Requirements
82
70
 
83
71
  Node.js >= 24.
84
72
 
85
- ## Current Limitations
86
-
87
- - Cloud sync is **dry-run + local-queue only** — no live credentialed transmission in this version.
88
- - No hosted dashboard; no billing or pricing active.
89
-
90
73
  ## License
91
74
 
92
75
  **Proprietary — all rights reserved.** Copyright (c) 2026 HappyLifeSaaS. This software is not open source.
93
76
  No permission is granted to use, copy, modify, distribute, or sell it except under a separate written
94
77
  agreement with the Owner. See [`LICENSE`](LICENSE). `package.json` declares `"license": "UNLICENSED"`.
95
- This posture is a pre-publication placeholder pending final legal review.