@spikonado/sprocket-linux-x64-gnu 0.3.7 → 0.3.8-dev.0bbcd99c5e4144db2a72272e4a457667166b7fd8
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 +41 -12
- package/THIRD_PARTY_NOTICES.md +0 -26
- package/bin/sprocket +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -26,6 +26,25 @@ npx @spikonado/sprocket
|
|
|
26
26
|
```
|
|
27
27
|
|
|
28
28
|
The above runs Sprocket through your browser unless you have the desktop app installed.
|
|
29
|
+
Browser launch URLs contain workspace navigation state only. The local server
|
|
30
|
+
creates the browser session after checking the socket peer, Origin, and Host.
|
|
31
|
+
|
|
32
|
+
### Remote browser access
|
|
33
|
+
|
|
34
|
+
Keep Sprocket on its default loopback address and put an HTTPS reverse proxy in
|
|
35
|
+
front of it. For example, Tailscale Serve can expose the local server inside
|
|
36
|
+
your tailnet:
|
|
37
|
+
|
|
38
|
+
```sh
|
|
39
|
+
tailscale serve --bg http://127.0.0.1:17731
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
Open the HTTPS URL printed by Tailscale. Remote browser sign-in uses WorkOS
|
|
43
|
+
device authorization and accepts only the account already signed in by
|
|
44
|
+
`sprocket login` on the host. Signing out in that browser revokes its browser
|
|
45
|
+
session without signing the host out. Plain remote HTTP is rejected. Other
|
|
46
|
+
reverse proxies must connect to Sprocket over loopback and preserve the
|
|
47
|
+
browser-facing `Host` header.
|
|
29
48
|
|
|
30
49
|
### Desktop app
|
|
31
50
|
|
|
@@ -46,6 +65,18 @@ To always open a tab in your browser when using Sprocket, use the `--web` flag:
|
|
|
46
65
|
sprocket --web
|
|
47
66
|
```
|
|
48
67
|
|
|
68
|
+
### Run an agent from the CLI
|
|
69
|
+
|
|
70
|
+
```sh
|
|
71
|
+
sprocket login
|
|
72
|
+
sprocket run "Fix the failing tests"
|
|
73
|
+
sprocket run --thread <thread-id> "Add regression coverage"
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
Inline prompts, `--prompt-file`, and stdin report only the current run. `--thread`
|
|
77
|
+
uses its history as context without replaying it. Progress goes to stderr, the
|
|
78
|
+
final answer to stdout, and full transcripts remain in the data directory and app.
|
|
79
|
+
|
|
49
80
|
### Workspaces
|
|
50
81
|
|
|
51
82
|
Pass a directory to open or reconnect that workspace in a new thread:
|
|
@@ -73,21 +104,21 @@ Run `sprocket --help` or `sprocket serve --help` for all options.
|
|
|
73
104
|
|
|
74
105
|
Common Sprocket server overrides are available as environment variables:
|
|
75
106
|
|
|
76
|
-
| Variable | Purpose
|
|
77
|
-
| ----------------------------- |
|
|
78
|
-
| `SPROCKET_DATA_DIR` | Directory for
|
|
79
|
-
| `SPROCKET_PORT` | Local server port; defaults to `17731` for installed use.
|
|
80
|
-
| `SPROCKET_HOST` | Bind host; defaults to `127.0.0.1`.
|
|
81
|
-
| `SPROCKET_DESKTOP_EXECUTABLE` | Full path to the desktop executable to be used by the Sprocket CLI.
|
|
82
|
-
| `PUBLIC_CONVEX_URL` | Convex deployment used by the agent runtime.
|
|
83
|
-
| `PUBLIC_MODEL_GATEWAY_URL` | Public AI gateway origin for the UI catalog (`GET /api/v1/models`).
|
|
84
|
-
| `SPROCKET_STATIC_DIR` | Web build to serve instead of the bundled build.
|
|
107
|
+
| Variable | Purpose |
|
|
108
|
+
| ----------------------------- | ----------------------------------------------------------------------- |
|
|
109
|
+
| `SPROCKET_DATA_DIR` | Directory for internal process identity, sessions, and workspace state. |
|
|
110
|
+
| `SPROCKET_PORT` | Local server port; defaults to `17731` for installed use. |
|
|
111
|
+
| `SPROCKET_HOST` | Bind host; defaults to `127.0.0.1`. |
|
|
112
|
+
| `SPROCKET_DESKTOP_EXECUTABLE` | Full path to the desktop executable to be used by the Sprocket CLI. |
|
|
113
|
+
| `PUBLIC_CONVEX_URL` | Convex deployment used by the agent runtime. |
|
|
114
|
+
| `PUBLIC_MODEL_GATEWAY_URL` | Public AI gateway origin for the UI catalog (`GET /api/v1/models`). |
|
|
115
|
+
| `SPROCKET_STATIC_DIR` | Web build to serve instead of the bundled build. |
|
|
85
116
|
|
|
86
117
|
## Development
|
|
87
118
|
|
|
88
119
|
### Requirements
|
|
89
120
|
|
|
90
|
-
- Bun 1.x, version 1.
|
|
121
|
+
- Bun 1.x, version 1.4.2 or newer
|
|
91
122
|
- Node.js 24.x, version 24.14 or newer
|
|
92
123
|
- A current stable Rust toolchain
|
|
93
124
|
|
|
@@ -105,8 +136,6 @@ Start the browser development environment:
|
|
|
105
136
|
bun dev
|
|
106
137
|
```
|
|
107
138
|
|
|
108
|
-
After creating a Convex deployment and configuring AuthKit, give the deployment an API key for each model provider you want to enable.
|
|
109
|
-
|
|
110
139
|
This runs Vite at `http://localhost:5173` and the Rust API at `http://127.0.0.1:7731`, with development state kept in `.sprocket-dev` inside the repository.
|
|
111
140
|
It targets the dev Convex deployment. To run against the production Convex
|
|
112
141
|
deployment with `~/.sprocket` state instead:
|
package/THIRD_PARTY_NOTICES.md
CHANGED
|
@@ -1,27 +1 @@
|
|
|
1
1
|
# Third-party notices
|
|
2
|
-
|
|
3
|
-
## pstack's `unslop` skill
|
|
4
|
-
|
|
5
|
-
Portions of [`crates/sprocket-agent/src/system_prompt.md`](./crates/sprocket-agent/src/system_prompt.md) are derived from [pstack's `unslop` skill](https://github.com/cursor/plugins/blob/99559f2f52047978602ef365589275831e76af07/pstack/skills/unslop/SKILL.md) and have been modified for use in Sprocket.
|
|
6
|
-
|
|
7
|
-
MIT License
|
|
8
|
-
|
|
9
|
-
Copyright (c) 2026 Lauren Tan
|
|
10
|
-
|
|
11
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
12
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
13
|
-
in the Software without restriction, including without limitation the rights
|
|
14
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
15
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
16
|
-
furnished to do so, subject to the following conditions:
|
|
17
|
-
|
|
18
|
-
The above copyright notice and this permission notice shall be included in all
|
|
19
|
-
copies or substantial portions of the Software.
|
|
20
|
-
|
|
21
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
22
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
23
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
24
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
25
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
26
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
27
|
-
SOFTWARE.
|
package/bin/sprocket
CHANGED
|
Binary file
|