@spikonado/sprocket-linux-arm64-gnu 0.3.9 → 0.4.0-dev.9cb656b594207b4e30bd001d4ac0dd8693da48b8
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 +17 -139
- package/THIRD_PARTY_NOTICES.md +0 -26
- package/bin/sprocket +0 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,173 +15,51 @@ Here's what makes Sprocket special:
|
|
|
15
15
|
|
|
16
16
|
## Using Sprocket
|
|
17
17
|
|
|
18
|
-
|
|
19
|
-
> You can run Sprocket using any of the ways defined below with no impact on Sprocket's capabilities or performance.
|
|
20
|
-
> The desktop app may take more RAM than using Sprocket through your browser.
|
|
21
|
-
|
|
22
|
-
### Run without installing
|
|
23
|
-
|
|
24
|
-
```sh
|
|
25
|
-
npx @spikonado/sprocket
|
|
26
|
-
```
|
|
18
|
+
### Desktop app
|
|
27
19
|
|
|
28
|
-
|
|
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.
|
|
20
|
+
Download the installer for your OS from the [latest release](https://github.com/spikonado/sprocket/releases/latest), install it, and open Sprocket. Sign in, choose a project folder, and ask Sprocket what you'd like to build.
|
|
31
21
|
|
|
32
|
-
###
|
|
22
|
+
### Run without installing
|
|
33
23
|
|
|
34
|
-
|
|
35
|
-
front of it. For example, Tailscale Serve can expose the local server inside
|
|
36
|
-
your tailnet:
|
|
24
|
+
With [Node.js](https://nodejs.org/) 20.11 or newer installed:
|
|
37
25
|
|
|
38
26
|
```sh
|
|
39
|
-
|
|
27
|
+
npx @spikonado/sprocket
|
|
40
28
|
```
|
|
41
29
|
|
|
42
|
-
|
|
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.
|
|
48
|
-
|
|
49
|
-
### Desktop app
|
|
50
|
-
|
|
51
|
-
Install it for your OS from the latest [GitHub Release Artifacts](https://github.com/spikonado/sprocket/releases) and run it.
|
|
30
|
+
This opens Sprocket in your browser, or in the desktop app if it's installed. Sign in and choose a project folder to get started. Add `--web` to always use your browser.
|
|
52
31
|
|
|
53
32
|
### CLI
|
|
54
33
|
|
|
55
34
|
```sh
|
|
56
|
-
npm
|
|
35
|
+
npm install -g @spikonado/sprocket
|
|
57
36
|
sprocket
|
|
58
37
|
```
|
|
59
38
|
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
To always open a tab in your browser when using Sprocket, use the `--web` flag:
|
|
63
|
-
|
|
64
|
-
```sh
|
|
65
|
-
sprocket --web
|
|
66
|
-
```
|
|
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
|
-
|
|
80
|
-
### Workspaces
|
|
81
|
-
|
|
82
|
-
Pass a directory to open or reconnect that workspace in a new thread:
|
|
39
|
+
Open a project folder in the app, or force it to open in your browser:
|
|
83
40
|
|
|
84
41
|
```sh
|
|
85
42
|
sprocket .
|
|
86
43
|
sprocket --web ../my-robot
|
|
87
44
|
```
|
|
88
45
|
|
|
89
|
-
|
|
90
|
-
Local state lives in `$HOME/.sprocket` (or `%USERPROFILE%\.sprocket` on Windows when `HOME` is unset).
|
|
91
|
-
Override with `SPROCKET_DATA_DIR`.
|
|
92
|
-
|
|
93
|
-
## Additional CLI reference
|
|
94
|
-
|
|
95
|
-
| Command | Behavior |
|
|
96
|
-
| --------------------------- | ------------------------------------------------------------------------------ |
|
|
97
|
-
| `sprocket update` | Update a global npm, bun, pnpm, or yarn install on the current channel. |
|
|
98
|
-
| `sprocket update --check` | Report whether an update is available without installing. |
|
|
99
|
-
| `sprocket upgrade` | Alias for `update`. |
|
|
100
|
-
| `sprocket serve` | Run the local server in the foreground without launching a client. |
|
|
101
|
-
| `sprocket serve --api-only` | Serve only `/api`; intended for development (see [Development](#development)). |
|
|
102
|
-
|
|
103
|
-
Run `sprocket --help` or `sprocket serve --help` for all options.
|
|
104
|
-
|
|
105
|
-
Common Sprocket server overrides are available as environment variables:
|
|
106
|
-
|
|
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. |
|
|
116
|
-
|
|
117
|
-
## Development
|
|
118
|
-
|
|
119
|
-
### Requirements
|
|
120
|
-
|
|
121
|
-
- Bun 1.x, version 1.4.2 or newer
|
|
122
|
-
- Node.js 24.x, version 24.14 or newer
|
|
123
|
-
- A current stable Rust toolchain
|
|
124
|
-
|
|
125
|
-
Install dependencies:
|
|
46
|
+
To run a task directly from your terminal, run these commands in your project folder:
|
|
126
47
|
|
|
127
48
|
```sh
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
### Running Sprocket
|
|
132
|
-
|
|
133
|
-
Start the browser development environment:
|
|
134
|
-
|
|
135
|
-
```sh
|
|
136
|
-
bun dev
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
After creating a Convex deployment and configuring AuthKit, give the deployment an API key for each model provider you want to enable.
|
|
140
|
-
|
|
141
|
-
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.
|
|
142
|
-
It targets the dev Convex deployment. To run against the production Convex
|
|
143
|
-
deployment with `~/.sprocket` state instead:
|
|
144
|
-
|
|
145
|
-
```sh
|
|
146
|
-
bun dev:prod
|
|
147
|
-
```
|
|
148
|
-
|
|
149
|
-
To develop against Electron instead, run:
|
|
150
|
-
|
|
151
|
-
```sh
|
|
152
|
-
bun dev:desktop
|
|
153
|
-
```
|
|
154
|
-
|
|
155
|
-
The `dev:prod` / `dev:prod:desktop` variants use the production Convex deployment and `~/.sprocket`.
|
|
156
|
-
|
|
157
|
-
### Building and testing
|
|
158
|
-
|
|
159
|
-
```sh
|
|
160
|
-
cargo test
|
|
161
|
-
bun run test
|
|
162
|
-
bun run build
|
|
163
|
-
prek run -a
|
|
164
|
-
```
|
|
165
|
-
|
|
166
|
-
Create a local Electron installer package with:
|
|
167
|
-
|
|
168
|
-
```sh
|
|
169
|
-
bun run build:release
|
|
49
|
+
sprocket login
|
|
50
|
+
sprocket run "Fix the failing tests"
|
|
170
51
|
```
|
|
171
52
|
|
|
172
|
-
|
|
173
|
-
Published installers come from GitHub Releases; the `sprocket` CLI is published separately on npm.
|
|
174
|
-
|
|
175
|
-
## License
|
|
176
|
-
|
|
177
|
-
Sprocket is licensed under the [Functional Source License, Version 1.1, ALv2 Future License](LICENSE.md). Third-party material remains under the licenses listed in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
|
|
53
|
+
Update your CLI installation with `sprocket update`. Run `sprocket --help` for more options.
|
|
178
54
|
|
|
179
55
|
## Troubleshooting
|
|
180
56
|
|
|
181
57
|
- If `17731` is already occupied, set `SPROCKET_PORT` before launching.
|
|
182
|
-
- If
|
|
183
|
-
your operating system credential service is available. Linux development
|
|
184
|
-
environments need a working Secret Service provider.
|
|
58
|
+
- If sign-in cannot save or restore your session, check that your operating system credential service is available, or use `sprocket login --credential-store file`.
|
|
185
59
|
- If `sprocket` opens the browser instead of the desktop app, install `sprocket-desktop` from [GitHub Releases](https://github.com/spikonado/sprocket/releases) onto `PATH`, or set `SPROCKET_DESKTOP_EXECUTABLE`.
|
|
186
60
|
- Unsigned macOS and Windows desktop builds may need a Gatekeeper / SmartScreen override the first time you open them.
|
|
187
61
|
- Contact [aarav@spikonado.com](mailto:aarav@spikonado.com) for help.
|
|
62
|
+
|
|
63
|
+
## License
|
|
64
|
+
|
|
65
|
+
Sprocket is licensed under the [Functional Source License, Version 1.1, ALv2 Future License](LICENSE.md). Third-party material remains under the licenses listed in [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md).
|
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
|
package/package.json
CHANGED