@spikonado/sprocket-linux-arm64-gnu 0.3.4 → 0.3.5-dev.3f6f94a15e83cc72a8eee4f2a5c6be5fe83cdadf

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.
Files changed (5) hide show
  1. package/LICENSE +7 -0
  2. package/README.md +156 -0
  3. package/THIRD_PARTY_NOTICES.md +27 -0
  4. package/bin/sprocket +0 -0
  5. package/package.json +3 -2
package/LICENSE CHANGED
@@ -103,3 +103,10 @@ Unless required by applicable law or agreed to in writing, software distributed
103
103
  under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
104
104
  CONDITIONS OF ANY KIND, either express or implied. See the License for the
105
105
  specific language governing permissions and limitations under the License.
106
+
107
+ ---
108
+
109
+ ## Third-party material
110
+
111
+ This license does not replace the licenses for third-party material included in Sprocket.
112
+ See [THIRD_PARTY_NOTICES.md](THIRD_PARTY_NOTICES.md) for those licenses and copyright notices.
package/README.md ADDED
@@ -0,0 +1,156 @@
1
+ # Sprocket
2
+
3
+ **Goal**: To make the world's best platform for developing hardware and software.
4
+
5
+ Here's what makes Sprocket special:
6
+
7
+ - The only AI agent that can work on both <ins>hardware</ins> and <ins>software</ins>.
8
+ - Retrieves best-in-class <ins>context from the web</ins> for everything it does, so it stays <ins>incredibly reliable</ins>.
9
+ - <ins>Buys anything from any website</ins> when you ask, from hardware parts to SaaS subscriptions.
10
+ - Makes <ins>beautifully detailed schematics</ins>, creates your <ins>BOM</ins>, and writes <ins>assembly instructions</ins>.
11
+
12
+ [Sprocket Demo](https://www.youtube.com/watch?v=E8KWO3Vh9YU)
13
+
14
+ [![Sprocket](./assets/sprocket.png)](https://www.youtube.com/watch?v=E8KWO3Vh9YU)
15
+
16
+ ## Using Sprocket
17
+
18
+ > [!NOTE]
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
+ ```
27
+
28
+ The above runs Sprocket through your browser unless you have the desktop app installed.
29
+
30
+ ### Desktop app
31
+
32
+ Install it for your OS from the latest [GitHub Release Artifacts](https://github.com/spikonado/sprocket/releases) and run it.
33
+
34
+ ### CLI
35
+
36
+ ```sh
37
+ npm i -g @spikonado/sprocket
38
+ sprocket
39
+ ```
40
+
41
+ The above runs Sprocket through your browser unless you have the desktop app installed.
42
+
43
+ To always open a tab in your browser when using Sprocket, use the `--web` flag:
44
+
45
+ ```sh
46
+ sprocket --web
47
+ ```
48
+
49
+ ### Workspaces
50
+
51
+ Pass a directory to open or reconnect that workspace in a new thread:
52
+
53
+ ```sh
54
+ sprocket .
55
+ sprocket --web ../my-robot
56
+ ```
57
+
58
+ Sprocket remembers attached workspaces and local server sessions between launches.
59
+ Local state lives in `$HOME/.sprocket` (or `%USERPROFILE%\.sprocket` on Windows when `HOME` is unset).
60
+ Override with `SPROCKET_DATA_DIR`.
61
+
62
+ ## Additional CLI reference
63
+
64
+ | Command | Behavior |
65
+ | --------------------------- | ------------------------------------------------------------------------------ |
66
+ | `sprocket update` | Update a global npm, bun, pnpm, or yarn install on the current channel. |
67
+ | `sprocket update --check` | Report whether an update is available without installing. |
68
+ | `sprocket upgrade` | Alias for `update`. |
69
+ | `sprocket serve` | Run the local server in the foreground without launching a client. |
70
+ | `sprocket serve --api-only` | Serve only `/api`; intended for development (see [Development](#development)). |
71
+
72
+ Run `sprocket --help` or `sprocket serve --help` for all options.
73
+
74
+ Common Sprocket server overrides are available as environment variables:
75
+
76
+ | Variable | Purpose |
77
+ | ----------------------------- | ------------------------------------------------------------------- |
78
+ | `SPROCKET_DATA_DIR` | Directory for pairing, sessions, and workspace state. |
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. |
85
+
86
+ ## Development
87
+
88
+ ### Requirements
89
+
90
+ - Bun 1.x, version 1.3.9 or newer
91
+ - Node.js 24.x, version 24.14 or newer
92
+ - A current stable Rust toolchain
93
+
94
+ Install dependencies:
95
+
96
+ ```sh
97
+ bun install
98
+ ```
99
+
100
+ ### Running Sprocket
101
+
102
+ Start the browser development environment:
103
+
104
+ ```sh
105
+ bun dev
106
+ ```
107
+
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
+ 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
+ It targets the dev Convex deployment. To run against the production Convex
112
+ deployment with `~/.sprocket` state instead:
113
+
114
+ ```sh
115
+ bun dev:prod
116
+ ```
117
+
118
+ To develop against Electron instead, run:
119
+
120
+ ```sh
121
+ bun dev:desktop
122
+ ```
123
+
124
+ The `dev:prod` / `dev:prod:desktop` variants use the production Convex deployment and `~/.sprocket`.
125
+
126
+ ### Building and testing
127
+
128
+ ```sh
129
+ cargo test
130
+ bun run test
131
+ bun run build
132
+ prek run -a
133
+ ```
134
+
135
+ Create a local Electron installer package with:
136
+
137
+ ```sh
138
+ bun run build:release
139
+ ```
140
+
141
+ Artifacts are written to `apps/desktop/dist/` as `sprocket-desktop-*` (`.AppImage` / `.dmg` / `.exe` depending on the host OS).
142
+ Published installers come from GitHub Releases; the `sprocket` CLI is published separately on npm.
143
+
144
+ ## License
145
+
146
+ 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).
147
+
148
+ ## Troubleshooting
149
+
150
+ - If `17731` is already occupied, set `SPROCKET_PORT` before launching.
151
+ - If installed sign-in cannot save or restore its native session, check that
152
+ your operating system credential service is available. Linux development
153
+ environments need a working Secret Service provider.
154
+ - 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`.
155
+ - Unsigned macOS and Windows desktop builds may need a Gatekeeper / SmartScreen override the first time you open them.
156
+ - Contact [aarav@spikonado.com](mailto:aarav@spikonado.com) for help.
package/THIRD_PARTY_NOTICES.md ADDED
@@ -0,0 +1,27 @@
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
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@spikonado/sprocket-linux-arm64-gnu",
3
- "version": "0.3.4",
3
+ "version": "0.3.5-dev.3f6f94a15e83cc72a8eee4f2a5c6be5fe83cdadf",
4
4
  "description": "Sprocket native executable for linux/arm64",
5
5
  "license": "FSL-1.1-ALv2",
6
6
  "os": [
@@ -10,7 +10,8 @@
10
10
  "arm64"
11
11
  ],
12
12
  "files": [
13
- "bin/"
13
+ "bin/",
14
+ "THIRD_PARTY_NOTICES.md"
14
15
  ],
15
16
  "repository": {
16
17
  "type": "git",