@hunterzhu/pulse-cli 0.2.0 → 0.2.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.
- package/README.md +55 -0
- package/dist/bin.js +1 -0
- package/dist/components/App.js +1 -0
- package/dist/config.d.ts +2 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
# @hunterzhu/pulse-cli
|
|
2
|
+
|
|
3
|
+
**A local-first AI assistant for coding, research, and everyday file tasks.**
|
|
4
|
+
|
|
5
|
+
Pulse runs in your project folder, keeps conversations on your machine, and can resume unfinished work. Requires Node.js 22+.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
Install the CLI globally so the `pulse` command is on your `PATH`:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install -g @hunterzhu/pulse-cli
|
|
13
|
+
pulse --version
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
For a one-off run, use `npx @hunterzhu/pulse-cli`. Commands below assume a global installation.
|
|
17
|
+
|
|
18
|
+
## Configure a model and API key
|
|
19
|
+
|
|
20
|
+
Create a starter configuration:
|
|
21
|
+
|
|
22
|
+
```bash
|
|
23
|
+
pulse setup
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
The configuration lives at `~/.pulse/config.json` (Windows:
|
|
27
|
+
`%USERPROFILE%\.pulse\config.json`). A fresh configuration includes the DeepSeek
|
|
28
|
+
provider and `deepseek-chat` model. Set `activeModel` to `deepseek-chat`, or use
|
|
29
|
+
`--model deepseek-chat` as below. The default `mock` model makes no API calls.
|
|
30
|
+
|
|
31
|
+
Set the API key in your shell; the DeepSeek provider uses
|
|
32
|
+
`apiKeyEnv: "DEEPSEEK_API_KEY"` to read it:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
export DEEPSEEK_API_KEY="your-key"
|
|
36
|
+
# Windows PowerShell: $env:DEEPSEEK_API_KEY="your-key"
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Usage
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
pulse --model deepseek-chat # interactive session
|
|
43
|
+
pulse run "Summarize this project" --model deepseek-chat
|
|
44
|
+
pulse sessions
|
|
45
|
+
pulse resume <conversation-id> "Continue" --model deepseek-chat
|
|
46
|
+
pulse doctor
|
|
47
|
+
pulse --read-only
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
See `pulse --help` for all options.
|
|
51
|
+
|
|
52
|
+
## Links
|
|
53
|
+
|
|
54
|
+
- [Full CLI configuration guide](https://github.com/zhuhengtan/Pulse/blob/main/docs/cli-config.md)
|
|
55
|
+
- [Source code and documentation](https://github.com/zhuhengtan/Pulse)
|
package/dist/bin.js
CHANGED
|
@@ -314,6 +314,7 @@ export async function hostOptions(parsed) {
|
|
|
314
314
|
...(configuredMaxTurns === undefined ? {} : { maxTurns: configuredMaxTurns }),
|
|
315
315
|
...(configuredAutoCompactPercent === undefined ? {} : { autoCompactPercent: Math.min(90, configuredAutoCompactPercent) }),
|
|
316
316
|
...(allowNetwork === undefined ? {} : { allowNetwork }),
|
|
317
|
+
...(config.networkHosts === undefined ? {} : { networkHosts: config.networkHosts }),
|
|
317
318
|
executionMode,
|
|
318
319
|
};
|
|
319
320
|
}
|
package/dist/components/App.js
CHANGED
|
@@ -183,6 +183,7 @@ export function App({ hostOptions, conversationId: initialConversationId, initia
|
|
|
183
183
|
maxTurns: hostOptions.maxTurns ?? 32,
|
|
184
184
|
autoCompactPercent: hostOptions.autoCompactPercent ?? 90,
|
|
185
185
|
allowNetwork: hostOptions.allowNetwork ?? false,
|
|
186
|
+
networkHosts: hostOptions.networkHosts ?? [],
|
|
186
187
|
}, null, 2),
|
|
187
188
|
createdAt: new Date().toISOString(),
|
|
188
189
|
});
|
package/dist/config.d.ts
CHANGED
|
@@ -74,6 +74,8 @@ export interface PulseCliConfig {
|
|
|
74
74
|
maxTurns?: number;
|
|
75
75
|
/** Percent of maxContextTokens that triggers automatic history compaction. Clamped to 1–90. */
|
|
76
76
|
autoCompactPercent?: number;
|
|
77
|
+
/** Explicit network destinations; workspace configuration cannot grant these. */
|
|
78
|
+
networkHosts?: string[];
|
|
77
79
|
allowNetwork?: boolean;
|
|
78
80
|
}
|
|
79
81
|
export declare const defaultPulseConfig: PulseCliConfig;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hunterzhu/pulse-cli",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"description": "A local-first AI task assistant for coding, research, and file workflows.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"ai",
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
"registry": "https://registry.npmjs.org"
|
|
36
36
|
},
|
|
37
37
|
"dependencies": {
|
|
38
|
-
"@hunterzhu/pulse-server": "0.2.
|
|
38
|
+
"@hunterzhu/pulse-server": "0.2.1",
|
|
39
39
|
"chalk": "^5.4.1",
|
|
40
40
|
"highlight.js": "^11.10.0",
|
|
41
41
|
"ink": "^7.1.1",
|