codebrief 1.1.12 → 1.1.13
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 +56 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -24,6 +24,7 @@ Add a single flag to have an AI model read your actual source files and rewrite
|
|
|
24
24
|
## Requirements
|
|
25
25
|
|
|
26
26
|
- **Node.js 16+** — that's it. Zero npm dependencies.
|
|
27
|
+
- Works on **macOS**, **Linux**, and **Windows**.
|
|
27
28
|
|
|
28
29
|
---
|
|
29
30
|
|
|
@@ -79,15 +80,65 @@ The `--ai` flag makes codebrief read your actual source files and use an AI mode
|
|
|
79
80
|
|
|
80
81
|
1. Go to [console.groq.com](https://console.groq.com) and create a free account (no credit card)
|
|
81
82
|
2. Create an API key
|
|
82
|
-
3. Set it
|
|
83
|
+
3. Set it:
|
|
84
|
+
|
|
85
|
+
**Option A — `.env.local` file (recommended, works on all OS)**
|
|
86
|
+
|
|
87
|
+
Create a `.env.local` file in your project root:
|
|
88
|
+
|
|
89
|
+
```
|
|
90
|
+
GROQ_API_KEY=gsk_xxxxxxxxxxxx
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
codebrief auto-loads this file. No terminal config needed.
|
|
94
|
+
|
|
95
|
+
**Option B — Global `~/.codebrief` file (works across all projects)**
|
|
96
|
+
|
|
97
|
+
Create a file at `~/.codebrief` (macOS/Linux: `~/.codebrief`, Windows: `C:\Users\<you>\.codebrief`):
|
|
98
|
+
|
|
99
|
+
```
|
|
100
|
+
GROQ_API_KEY=gsk_xxxxxxxxxxxx
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
**Option C — Environment variable**
|
|
104
|
+
|
|
105
|
+
<details>
|
|
106
|
+
<summary>macOS / Linux</summary>
|
|
83
107
|
|
|
84
108
|
```bash
|
|
85
109
|
export GROQ_API_KEY=gsk_xxxxxxxxxxxx
|
|
86
110
|
|
|
87
|
-
#
|
|
88
|
-
echo 'export GROQ_API_KEY=gsk_xxxxxxxxxxxx' >> ~/.zshrc
|
|
111
|
+
# Make permanent:
|
|
112
|
+
echo 'export GROQ_API_KEY=gsk_xxxxxxxxxxxx' >> ~/.zshrc # zsh
|
|
113
|
+
echo 'export GROQ_API_KEY=gsk_xxxxxxxxxxxx' >> ~/.bashrc # bash
|
|
89
114
|
```
|
|
90
115
|
|
|
116
|
+
</details>
|
|
117
|
+
|
|
118
|
+
<details>
|
|
119
|
+
<summary>Windows — PowerShell</summary>
|
|
120
|
+
|
|
121
|
+
```powershell
|
|
122
|
+
$env:GROQ_API_KEY="gsk_xxxxxxxxxxxx"
|
|
123
|
+
|
|
124
|
+
# Make permanent (user-level):
|
|
125
|
+
[System.Environment]::SetEnvironmentVariable('GROQ_API_KEY', 'gsk_xxxxxxxxxxxx', 'User')
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
</details>
|
|
129
|
+
|
|
130
|
+
<details>
|
|
131
|
+
<summary>Windows — CMD</summary>
|
|
132
|
+
|
|
133
|
+
```cmd
|
|
134
|
+
set GROQ_API_KEY=gsk_xxxxxxxxxxxx
|
|
135
|
+
|
|
136
|
+
:: Make permanent:
|
|
137
|
+
setx GROQ_API_KEY gsk_xxxxxxxxxxxx
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
</details>
|
|
141
|
+
|
|
91
142
|
4. Run:
|
|
92
143
|
|
|
93
144
|
```bash
|
|
@@ -107,6 +158,8 @@ codebrief --ai
|
|
|
107
158
|
|
|
108
159
|
**Groq and Gemini are both free** — no credit card required. Groq is fastest (~2–3s), Gemini offers Google's latest models.
|
|
109
160
|
|
|
161
|
+
> **Setting keys:** Use any method from the [Setup](#setup-30-seconds-free) section above — `.env.local`, `~/.codebrief`, or environment variables. All methods work for every provider.
|
|
162
|
+
|
|
110
163
|
### Browsing Available Models
|
|
111
164
|
|
|
112
165
|
Use `--models` to see all available models for any provider before running `--ai`:
|
package/package.json
CHANGED