scai 1.0.0 → 1.0.1

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 (2) hide show
  1. package/README.md +69 -53
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -11,8 +11,13 @@
11
11
  - **No telemetry**
12
12
  - **Your code stays on your machine**
13
13
 
14
- Website: [https://scai.dk](https://scai.dk)
15
- Built in Denmark / EU
14
+ Built in Denmark and the EU with ❤️
15
+
16
+ ## Feedback And Support
17
+
18
+ Reach out with feedback or questions:
19
+
20
+ - Threads: [@scai.dk](https://threads.net/@scai.dk)
16
21
 
17
22
  ## What SCAI Is Good At
18
23
 
@@ -30,48 +35,6 @@ It is good at:
30
35
  - Helping with small light code changes in a limited area
31
36
  - Writing commit messages from staged changes
32
37
 
33
- ## Current Limits
34
-
35
- SCAI is not a full replacement for a strong cloud coding agent.
36
-
37
- Today it works best when:
38
-
39
- - The task is about understanding code already in the repo
40
- - The task is about changing code that already exists
41
- - The change is small and local
42
- - You want grounded answers tied to real files
43
-
44
- Scai is not for:
45
-
46
- - Building brand new features from scratch
47
- - Large refactors across many files
48
- - Broad automated rewrite requests
49
- - Tasks that need bash actions, file creation, or other execution steps
50
- - Tasks that depend on web access or external services
51
-
52
- Important current limit:
53
-
54
- - SCAI can refactor code that already exists
55
- - SCAI is not yet a good fit for building new features end to end
56
- - SCAI does not currently act like a shell agent that runs bash steps to create files, wire systems together, or drive external tools
57
- - SCAI does not handle large file refactors well. It's capped at 1000 lines.
58
-
59
- *SCAI was tested on an MacBook Pro M1 max (64GB). If you have a faster machine you may experience better performance and be able to use above 30b parameter models.*
60
-
61
- ## Privacy And Cost
62
-
63
- SCAI runs with local models only.
64
-
65
- That means:
66
-
67
- - No API keys
68
- - No metered token billing
69
- - No remote prompt processing
70
- - No web browsing by the agent
71
- - No prompt injection from fetched web content
72
-
73
- This makes it a good fit for private code, internal repos, and teams that want a simple offline workflow.
74
-
75
38
  ## Getting Started
76
39
 
77
40
  Install the CLI:
@@ -99,7 +62,12 @@ This will:
99
62
  - Help you pick or install a local model
100
63
  - Start local indexing
101
64
 
102
- For most users, this is enough. Start with `scai setup` and only use the manual model commands below if you want to pick a specific model yourself.
65
+ For most users, this is enough. Start with `scai setup` and only use the manual model commands below if you want to pick a specific model yourself. Run:
66
+
67
+ ```bash
68
+ scai status
69
+ ```
70
+ ...to check that setup worked.
103
71
 
104
72
  For best results on a 64 GB machine, use:
105
73
 
@@ -156,6 +124,48 @@ Help me add comments to this file.
156
124
  Help me make a small cleanup in this module.
157
125
  ```
158
126
 
127
+ ## Current Limits
128
+
129
+ SCAI is not a full replacement for a strong cloud coding agent.
130
+
131
+ Today it works best when:
132
+
133
+ - The task is about understanding code already in the repo
134
+ - The task is about changing code that already exists
135
+ - The change is small and local
136
+ - You want grounded answers tied to real files
137
+
138
+ SCAI is not for:
139
+
140
+ - Building brand new features from scratch
141
+ - Large refactors across many files
142
+ - Broad automated rewrite requests
143
+ - Tasks that need bash actions, file creation, or other execution steps
144
+ - Tasks that depend on web access or external services
145
+
146
+ Important current limit:
147
+
148
+ - SCAI can refactor code that already exists
149
+ - SCAI is not yet a good fit for building new features end to end
150
+ - SCAI does not currently act like a shell agent that runs bash steps to create files, wire systems together, or drive external tools
151
+ - SCAI does not handle large file refactors well. It's capped at 1000 lines.
152
+
153
+ *SCAI was tested on an MacBook Pro M1 max (64GB). If you have a faster machine you may experience better performance and be able to use above 30b parameter models.*
154
+
155
+ ## Privacy And Cost
156
+
157
+ SCAI runs with local models only.
158
+
159
+ That means:
160
+
161
+ - No API keys
162
+ - No metered token billing
163
+ - No remote prompt processing
164
+ - No web browsing by the agent
165
+ - No prompt injection from fetched web content
166
+
167
+ This makes it a good fit for private code, internal repos, and teams that want a simple offline workflow.
168
+
159
169
  ## Tasks And Resume
160
170
 
161
171
  SCAI can keep task context so you can continue later.
@@ -220,6 +230,14 @@ Only repositories that have been set up are available to the agent.
220
230
 
221
231
  SCAI uses a local Ollama server.
222
232
 
233
+ Download Ollama here: [https://ollama.com/download](https://ollama.com/download)
234
+
235
+ To download a model with Ollama, run:
236
+
237
+ ```bash
238
+ ollama pull qwen3-coder:30b
239
+ ```
240
+
223
241
  Useful commands:
224
242
 
225
243
  ```bash
@@ -229,16 +247,10 @@ scai config show --raw
229
247
  scai config set-model qwen3-coder:30b
230
248
  ```
231
249
 
232
- If you want to manage models manually, download one with Ollama:
233
-
234
- ```bash
235
- ollama pull gemma4:e4b-mlx
236
- ```
237
-
238
- Then point SCAI at that model:
250
+ Then point SCAI at the downloaded model:
239
251
 
240
252
  ```bash
241
- scai config set-model gemma4:e4b-mlx
253
+ scai config set-model qwen3-coder:30b
242
254
  ```
243
255
 
244
256
  If `scai setup` worked, you usually do not need to touch this often.
@@ -271,3 +283,7 @@ If you need to inspect the current task state:
271
283
  scai context
272
284
  scai task show <id>
273
285
  ```
286
+
287
+ ## Maintainer Release Flow
288
+
289
+ The CLI release workflow is documented in [release-procedure.md](/Users/rzs/dev/repos/scai/release-procedure.md).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "scai",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "type": "module",
5
5
  "bin": {
6
6
  "scai": "./dist/index.js"