@spikonado/sprocket-darwin-arm64 0.3.7 → 0.3.8
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 -10
- 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
|
|
package/bin/sprocket
CHANGED
|
Binary file
|