@arsh342/athena 0.1.4 → 0.1.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.
package/README.md CHANGED
@@ -1,8 +1,8 @@
1
- # Athena
1
+ # Athena CLI
2
2
 
3
3
  AI code provenance tracker for JavaScript and TypeScript repositories.
4
4
 
5
- Athena scans JS/TS/JSX/TSX files, extracts function-level code units, scores AI-likelihood with heuristic signals, and runs targeted security checks on flagged sections.
5
+ Athena scans JS/TS/JSX/TSX files, extracts function-level code units, scores AI-origin likelihood with local heuristics, and runs targeted security checks.
6
6
 
7
7
  ## Install
8
8
 
@@ -10,15 +10,17 @@ Athena scans JS/TS/JSX/TSX files, extracts function-level code units, scores AI-
10
10
  npm install -g @arsh342/athena
11
11
  ```
12
12
 
13
- ## Use
13
+ ## Quick Start
14
14
 
15
- Open the terminal selector:
15
+ Open interactive selector:
16
16
 
17
17
  ```bash
18
18
  athena
19
+ # or
20
+ athena menu
19
21
  ```
20
22
 
21
- Scan a repository:
23
+ Scan current directory:
22
24
 
23
25
  ```bash
24
26
  athena scan .
@@ -30,19 +32,28 @@ Check staged files:
30
32
  athena check
31
33
  ```
32
34
 
33
- Install the pre-commit hook:
35
+ Install pre-commit hook:
34
36
 
35
37
  ```bash
36
38
  athena init
37
39
  ```
38
40
 
39
- Remove the hook:
41
+ Remove pre-commit hook:
40
42
 
41
43
  ```bash
42
44
  athena uninstall
43
45
  ```
44
46
 
45
- ## Output formats
47
+ ## Common Options
48
+
49
+ Set threshold (default is `9`):
50
+
51
+ ```bash
52
+ athena scan . --threshold 9
53
+ athena check --threshold 9
54
+ ```
55
+
56
+ Choose output format:
46
57
 
47
58
  ```bash
48
59
  athena scan . --format terminal
@@ -50,9 +61,44 @@ athena scan . --format json
50
61
  athena scan . --format jsonl
51
62
  ```
52
63
 
64
+ ## Terminal UI Behavior
65
+
66
+ - Selector mode renders in-place and re-renders dynamically.
67
+ - Scan/check reports separate AI-origin confidence from security findings.
68
+ - Direct command runs clear the terminal before rendering report output.
69
+
70
+ ## Report Highlights
71
+
72
+ Terminal reports include:
73
+
74
+ - Top-level metrics (`files`, `units`, `ai-flagged units`, `duration`)
75
+ - AI-origin confidence section
76
+ - Top weighted signals
77
+ - Security findings section
78
+ - Gate status and gate reason
79
+
80
+ ## Development
81
+
82
+ Run from source:
83
+
84
+ ```bash
85
+ npm run dev -w @arsh342/athena -- menu
86
+ ```
87
+
88
+ Quiet npm wrapper output:
89
+
90
+ ```bash
91
+ npm run -s dev -w @arsh342/athena -- menu
92
+ ```
93
+
94
+ Build:
95
+
96
+ ```bash
97
+ npm run build -w @arsh342/athena
98
+ ```
99
+
53
100
  ## Notes
54
101
 
102
+ - Runs fully local (no external AI service required).
55
103
  - Supports JavaScript, TypeScript, JSX, and TSX.
56
- - Runs locally.
57
104
  - Requires Node.js 18 or newer.
58
- - Current release includes heuristic scoring, secret detection, hallucinated API checks, and ANSI terminal reports.