@arsh342/athena 0.4.3 → 0.5.0

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 +21 -1
  2. package/dist/index.cjs +2870 -2177
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -25,7 +25,15 @@ athena init # install the pre-commit hook (athena uninstall r
25
25
  athena doctor # check Node, npm, git and ESLint
26
26
  ```
27
27
 
28
- Running `athena` with no arguments opens an interactive menu. On a tall terminal (52 rows or more) it opens with the Athena owl, drawn in braille dots; on a shorter one it shows the compact name instead.
28
+ Running `athena` with no arguments opens an interactive menu, so you can pick what to do instead of typing commands and flags. Move with the arrow keys (or press a number), Enter selects, Esc goes back. Each screen shows the command it is equivalent to.
29
+
30
+ - **Scan:** this folder offline, with the AI check (pick a service, mode, model and spend cap), a different folder, or custom options (what blocks, the output format, dependency checks).
31
+ - **Review my changes:** what is staged, everything uncommitted, everything since a branch, or a commit range, with the AI check if you want it.
32
+ - **AI keys:** add, see or remove a key for Anthropic, OpenAI, Google, Groq, OpenRouter, DeepSeek, Mistral, xAI or Together. The key is typed hidden and saved privately on your machine.
33
+ - **Git hooks:** install the commit gate (and the push gate) or remove them.
34
+ - **Vulnerability data, Explain a finding, Skills and provenance, Project settings** (what blocks a commit, saved to `athena.config.json`), **Doctor** and **All commands**.
35
+
36
+ Without a terminal (CI, a pipe) it prints the command help instead.
29
37
 
30
38
  ## Commands
31
39
 
@@ -148,6 +156,18 @@ Skills are data only and contain no code. Regular expressions are checked before
148
156
  - **MCP server.** `claude mcp add athena -- npx -y @arsh342/athena mcp`. Other clients: [MCP client setup](https://github.com/arsh342/athena/blob/main/docs/agents/mcp-clients.md). No AI model is called and no key is needed.
149
157
  - **Claude Code plugin.** `claude plugin marketplace add arsh342/athena` then `claude plugin install athena@athena` (or, from a clone, `claude plugin install ./plugins/athena`) for `/athena-scan`, `/athena-review`, the `athena-security` skill, a researcher and a verifier agent, and hooks. Other agents: `npx skills add arsh342/athena`.
150
158
 
159
+ ## Sharing anonymous labels (optional, off by default)
160
+
161
+ Athena can send anonymous statistics to help improve AI-code detection. It never sends code. A record is: AI or human, how that was established (git history, pre-2021 code, or your own mark), the language, a size bucket, about 35 style numbers, the detector's probability and version, and a random install id that rotates every 90 days.
162
+
163
+ ```bash
164
+ athena learning share status # what is on or off, and the exact record that would be sent
165
+ athena learning share on # sends to https://athena-g3hp.onrender.com (override: ATHENA_SHARE_URL or --server)
166
+ athena learning share off --delete # stop, and ask the server to delete everything sent from this install
167
+ ```
168
+
169
+ Never on in CI, never asked from git hooks (the one-time question appears only after an explicit `athena scan`), and a repository can force it off with `"learning": { "share": "off" }` in `athena.config.json` (a repository setting of "on" is ignored). A dead or slow server never delays a scan by more than 3 seconds. Records go to Athena's own server unless you point `ATHENA_SHARE_URL` or `--server` elsewhere.
170
+
151
171
  ## Staying current
152
172
 
153
173
  `athena update` keeps a local, incrementally updated copy of the OSV database for the ecosystems you use, plus CISA KEV and EPSS, and fetches the newest signed rule and skill pack (accepted only if its Ed25519 signature and SHA-256 verify and every rule passes its own fixtures). After a scan, data older than 24 hours is refreshed in the background; `--offline` disables that. Only public data is downloaded; nothing about your code is sent. `athena alerts` re-checks your last scan against current data.