scai 0.1.31 → 0.1.32
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 +8 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
|
-
# ⚙️ scai —
|
|
1
|
+
# ⚙️ scai — Smart Commit AI ✨
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
> AI-powered CLI tool for commits and summaries — using local models.
|
|
2
5
|
|
|
3
|
-
> AI-powered CLI tool for commits, summaries, search, questions, and more — using local models.
|
|
4
6
|
|
|
5
7
|
**scai** is a privacy-first, local AI assistant for developers. It brings semantic understanding to your codebase, directly from the terminal:
|
|
6
8
|
|
|
@@ -9,7 +11,7 @@
|
|
|
9
11
|
- 🧐 Summarize files in plain English
|
|
10
12
|
- 📜 Auto-update your changelog
|
|
11
13
|
- 🧪 Generate Jest tests (ALPHA)
|
|
12
|
-
- 🔍 Search and ask questions across your codebase (
|
|
14
|
+
- 🔍 Search and ask questions across your codebase (ALPHA)
|
|
13
15
|
- 🔐 100% local — no API keys, no cloud, no telemetry
|
|
14
16
|
|
|
15
17
|
---
|
|
@@ -17,7 +19,7 @@
|
|
|
17
19
|
## 🚀 Features
|
|
18
20
|
|
|
19
21
|
- ⚡ Powered by open-source models (e.g. `llama3`, `codellama`)
|
|
20
|
-
- 🔍 Full-text indexing & semantic search (
|
|
22
|
+
- 🔍 Full-text indexing & semantic search (ALPHA)
|
|
21
23
|
- 🛠️ Built with Node.js and TypeScript
|
|
22
24
|
- ✅ Easily configurable via CLI or global flags
|
|
23
25
|
|
|
@@ -115,7 +117,7 @@ scai stores settings in `~/.scai/config.json`. You can override or view them:
|
|
|
115
117
|
|
|
116
118
|
<br>
|
|
117
119
|
|
|
118
|
-
## 🔁 Background Daemon and Indexing ⚠️
|
|
120
|
+
## 🔁 Background Daemon and Indexing ⚠️ ALPHA Notice
|
|
119
121
|
|
|
120
122
|
These features are experimental and subject to change:
|
|
121
123
|
|
|
@@ -137,7 +139,7 @@ You won't gain much value from the index unless you scope it to one repository.
|
|
|
137
139
|
|
|
138
140
|
---
|
|
139
141
|
|
|
140
|
-
### 🔍 Codebase Search & Ask (
|
|
142
|
+
### 🔍 Codebase Search & Ask (ALPHA)
|
|
141
143
|
|
|
142
144
|
> **Important:** You must `index` a **code repository** first or `find` and `ask` have no context to work with.
|
|
143
145
|
|