cli-surf 0.11.0
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 +52 -0
- package/cli.js +1239 -0
- package/cliPrompt.js +527 -0
- package/cliSkills.js +264 -0
- package/cliTools.js +490 -0
- package/cliUi.js +436 -0
- package/opusModels.js +83 -0
- package/package.json +31 -0
- package/skills/commit/SKILL.md +21 -0
- package/skills/review/SKILL.md +29 -0
package/README.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# surf-opus
|
|
2
|
+
|
|
3
|
+
Terminal client for Surf messenger (`surf` / `opus` commands) — chat, models, usage and files with AI limits shared with the messenger.
|
|
4
|
+
|
|
5
|
+
## Install (one command, like codex)
|
|
6
|
+
|
|
7
|
+
```sh
|
|
8
|
+
npm install -g surf-opus
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Requires Node.js 22+. No other dependencies.
|
|
12
|
+
|
|
13
|
+
## First run
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
surf login --server https://your-surf-host
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
Then just:
|
|
20
|
+
|
|
21
|
+
```sh
|
|
22
|
+
surf
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
`surf` without arguments opens the chat (browser login if needed). If your server is on `localhost:3001`, no `--server` flag is needed.
|
|
26
|
+
|
|
27
|
+
## Commands
|
|
28
|
+
|
|
29
|
+
- `surf` — chat with auto-login
|
|
30
|
+
- `surf ask <text>` — one-shot question (`--model`, `--no-stream`, `--attach`, `--json`)
|
|
31
|
+
- `surf usage` — shared AI limit
|
|
32
|
+
- `surf models` — available models
|
|
33
|
+
- `surf get <url> [--open]` — download Opus attachments
|
|
34
|
+
- `surf login`, `surf logout`, `surf whoami`
|
|
35
|
+
|
|
36
|
+
Inside chat: `/usage`, `/model`, `/permissions`, `/skills`, `/clear`, `/help`, `/exit`. `/permissions` saves one of three modes: always ask, ask only for important actions (default), or never ask.
|
|
37
|
+
Drag & drop files into the terminal to attach them (`[image N]` chips).
|
|
38
|
+
Prefix a message with `!` to force it as a file task.
|
|
39
|
+
|
|
40
|
+
## Agent skills
|
|
41
|
+
|
|
42
|
+
Skills are folders with a `SKILL.md` (frontmatter `name` + `description` + instructions, Claude-compatible format), optionally with scripts. The agent sees the catalog and loads skills on demand; `/name` runs one, `/skills` lists them.
|
|
43
|
+
|
|
44
|
+
Locations (later wins): built-in `skills/` next to the CLI, `~/.surf-cli/skills/<name>/`, `<project>/.surf/skills/<name>/`.
|
|
45
|
+
|
|
46
|
+
## Publishing (maintainers)
|
|
47
|
+
|
|
48
|
+
Built JS is gitignored — build first, then publish from this folder:
|
|
49
|
+
|
|
50
|
+
```sh
|
|
51
|
+
cd server && npm run build && cd cli-dist && npm publish --access public
|
|
52
|
+
```
|