@spikonado/sprocket 0.3.2 → 0.3.4-dev.04deb785bd4d32787658e847593187577d69a7fc

package/README.md

@@ -27,7 +27,7 @@ npx @spikonado/sprocket
 
 The above runs Sprocket through your browser unless you have the desktop app installed.
 
-### Desktop App
+### Desktop app
 
 Install it for your OS from the latest [GitHub Release Artifacts](https://github.com/spikonado/sprocket/releases) and run it.
 
@@ -63,6 +63,9 @@ Override with `SPROCKET_DATA_DIR`.
 
 | Command                     | Behavior                                                                       |
 | --------------------------- | ------------------------------------------------------------------------------ |
+| `sprocket update`           | Update a global npm, bun, pnpm, or yarn install on the current channel.        |
+| `sprocket update --check`   | Report whether an update is available without installing.                      |
+| `sprocket upgrade`          | Alias for `update`.                                                            |
 | `sprocket serve`            | Run the local server in the foreground without launching a client.             |
 | `sprocket serve --api-only` | Serve only `/api`; intended for development (see [Development](#development)). |
 
@@ -77,6 +80,7 @@ Common Sprocket server overrides are available as environment variables:
 | `SPROCKET_HOST`               | Bind host; defaults to `127.0.0.1`.                                 |
 | `SPROCKET_DESKTOP_EXECUTABLE` | Full path to the desktop executable to be used by the Sprocket CLI. |
 | `PUBLIC_CONVEX_URL`           | Convex deployment used by the agent runtime.                        |
+| `PUBLIC_MODEL_GATEWAY_URL`    | Public AI gateway origin for the UI catalog (`GET /api/v1/models`). |
 | `SPROCKET_STATIC_DIR`         | Web build to serve instead of the bundled build.                    |
 
 ## Development
@@ -101,15 +105,24 @@ Start the browser development environment:
 bun dev
 ```
 
-After creating a convex deployment and configuring authkit following the instructions, configure the Convex deployment with the API key for each model provider you want to enable.
+After creating a Convex deployment and configuring AuthKit, give the deployment an API key for each model provider you want to enable.
 
 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.
+It targets the dev Convex deployment. To run against the production Convex
+deployment with `~/.sprocket` state instead:
+
+```sh
+bun dev:prod
+```
+
 To develop against Electron instead, run:
 
 ```sh
 bun dev:desktop
 ```
 
+The `dev:prod` / `dev:prod:desktop` variants use the production Convex deployment and `~/.sprocket`.
+
 ### Building and testing
 
 ```sh
@@ -131,6 +144,9 @@ Published installers come from GitHub Releases; the `sprocket` CLI is published
 ## Troubleshooting
 
 - If `17731` is already occupied, set `SPROCKET_PORT` before launching.
+- If installed sign-in cannot save or restore its native session, check that
+  your operating system credential service is available. Linux development
+  environments need a working Secret Service provider.
 - 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`.
 - Unsigned macOS and Windows desktop builds may need a Gatekeeper / SmartScreen override the first time you open them.
 - Contact [aarav@spikonado.com](mailto:aarav@spikonado.com) for help.

package/bin/sprocket.js

@@ -2,4 +2,4 @@
 
 import { launch } from '../lib/launcher.js';
 
-launch(process.argv.slice(2));
+await launch(process.argv.slice(2));

package/lib/launcher.js

@@ -2,7 +2,8 @@ import { spawnSync } from 'node:child_process';
 import { accessSync, chmodSync, constants, readFileSync } from 'node:fs';
 import { createRequire } from 'node:module';
 import path from 'node:path';
-import { fileURLToPath } from 'node:url';
+
+import { createHost, parseUpdateArgs, runUpdateCli, UPDATE_API_FILENAME } from './update.js';
 
 const require = createRequire(import.meta.url);
 
@@ -74,20 +75,45 @@ export function run(binary, args, options = {}) {
 	return result.status ?? 1;
 }
 
-export function launch(args) {
+export function nativeChildEnvironment(env, staticDir, updateNode, updateScript) {
+	const next = {
+		...env,
+		SPROCKET_STATIC_DIR: env.SPROCKET_STATIC_DIR || staticDir,
+		SPROCKET_UPDATE_NODE: updateNode,
+		SPROCKET_UPDATE_SCRIPT: updateScript
+	};
+	delete next.SPROCKET_UPDATE_MANAGED;
+	return next;
+}
+
+export async function launch(args, options = {}) {
+	const env = { ...(options.env ?? process.env) };
+	delete env.SPROCKET_UPDATE_MANAGED;
+	const parsed = parseUpdateArgs(args);
+	if (parsed.kind !== 'none') {
+		const code = await runUpdateCli(parsed, options.host ?? createHost({ env }));
+		process.exitCode = code;
+		return code;
+	}
+
 	try {
-		const packageRoot = path.dirname(fileURLToPath(import.meta.url));
-		const staticDir = path.resolve(packageRoot, '../web');
-		const binary = resolveNativeBinary();
-		ensureExecutable(binary);
+		const libDir = options.libDir ?? import.meta.dirname;
+		const staticDir = path.resolve(libDir, '../web');
+		const binary = (options.resolveBinary ?? resolveNativeBinary)();
+		(options.ensureExecutable ?? ensureExecutable)(binary);
 		process.exitCode = run(binary, args, {
-			env: {
-				...process.env,
-				SPROCKET_STATIC_DIR: process.env.SPROCKET_STATIC_DIR || staticDir
-			}
+			env: nativeChildEnvironment(
+				env,
+				staticDir,
+				options.execPath ?? process.execPath,
+				path.resolve(libDir, UPDATE_API_FILENAME)
+			),
+			spawn: options.spawn
 		});
+		return process.exitCode;
 	} catch (error) {
 		console.error(`sprocket: ${error.message}`);
 		process.exitCode = 1;
+		return 1;
 	}
 }

package/lib/update-api.js

@@ -0,0 +1,5 @@
+import { runUpdateApi } from './update.js';
+
+const { exitCode, payload } = await runUpdateApi(process.argv[2]);
+process.stdout.write(`${JSON.stringify(payload)}\n`);
+process.exitCode = exitCode;