@sciilo.ai/codex-sidecar 0.1.0 → 0.2.1

package/README.md

@@ -76,37 +76,24 @@ npm --version
 
 The first command must display `v22` or a higher version number.
 
-### 2. Download and install the sidecar
+### 2. Install the sidecar
 
-From this repository's GitHub page:
-
-1. click **Code**, then **Download ZIP**;
-2. extract the downloaded archive;
-3. open a terminal in the extracted folder;
-4. run:
+Open a terminal — anywhere, the folder does not matter — and run:
 
 ```shell
-chmod +x install.sh
-./install.sh
+npm install -g @sciilo.ai/codex-sidecar
 ```
 
 The installation automatically downloads the Codex version selected for the
 sidecar and the binary matching your computer. Codex remains a private
 dependency: no global `codex` command is required.
 
-You may move or delete the downloaded folder after installation without
-breaking the installed command.
-
 Check that the sidecar is available:
 
 ```shell
-sciilo-sidecar --help
+sciilo-codex --help
 ```
 
-> On Windows, use
-> [WSL](https://learn.microsoft.com/windows/wsl/install), because the
-> installation script uses Bash.
-
 ### 3. Generate the Sciilo connection key
 
 1. open Sciilo and sign in;
@@ -127,7 +114,7 @@ session, or an OpenAI API key.
 Run:
 
 ```shell
-sciilo-sidecar setup
+sciilo-codex setup
 ```
 
 The program asks for:
@@ -162,7 +149,7 @@ To keep the key out of your terminal history, enter it silently:
 read -s -p "OpenAI API key: " SCIILO_CODEX_API_KEY
 echo
 export SCIILO_CODEX_API_KEY
-sciilo-sidecar setup
+sciilo-codex setup
 unset SCIILO_CODEX_API_KEY
 ```
 
@@ -180,7 +167,7 @@ key uses your OpenAI Platform organization's usage-based billing. See the
 for details.
 
 The sidecar configuration is stored in
-`~/.config/sciilo-sidecar/config.json`, with permissions restricted to your
+`~/.config/sciilo-codex/config.json`, with permissions restricted to your
 user account. One configuration works for every project on the computer.
 
 ### 5. Start the sidecar in a project
@@ -189,7 +176,7 @@ Open a terminal in the project folder:
 
 ```shell
 cd /path/to/my-project
-sciilo-sidecar
+sciilo-codex
 ```
 
 The current folder becomes the Codex workspace and selects the corresponding
@@ -199,7 +186,7 @@ project in Sciilo. Keep this terminal open while using the sidecar. Press
 To select a folder without changing directories:
 
 ```shell
-sciilo-sidecar --workspace /path/to/my-project
+sciilo-codex --workspace /path/to/my-project
 ```
 
 ## Everyday use
@@ -207,14 +194,14 @@ sciilo-sidecar --workspace /path/to/my-project
 Display the configuration and Codex sign-in status:
 
 ```shell
-sciilo-sidecar status
+sciilo-codex status
 ```
 
 Open another project:
 
 ```shell
 cd /path/to/another-project
-sciilo-sidecar
+sciilo-codex
 ```
 
 Only one sidecar may use a connection key at a time. If two processes connect
@@ -223,15 +210,31 @@ replacing each other.
 
 ## Updating
 
-Download and extract the new repository version, then run:
-
 ```shell
-./install.sh
+npm install -g @sciilo.ai/codex-sidecar@latest
 ```
 
 The sidecar and its private Codex runtime are replaced together. Your Sciilo
 configuration and local Codex session are preserved.
 
+### Coming from 0.1.0
+
+The command was called `sciilo-sidecar` in 0.1.0. It is now `sciilo-codex`, to
+match `sciilo-claude` and to say which Agent it carries. Remove the old command
+before installing, otherwise it stays in your `PATH` alongside the new one:
+
+```shell
+npm uninstall -g @sciilo.ai/codex-sidecar
+npm install -g @sciilo.ai/codex-sidecar
+```
+
+The configuration directory follows the same rename. Move it to keep your
+pairing, or run `sciilo-codex setup` again:
+
+```shell
+mv ~/.config/sciilo-sidecar ~/.config/sciilo-codex
+```
+
 ## Uninstalling
 
 Remove the sidecar and its private Codex runtime:
@@ -241,7 +244,7 @@ npm uninstall --global @sciilo.ai/codex-sidecar
 ```
 
 This command does not remove the configuration stored in
-`~/.config/sciilo-sidecar/` or the local session managed by Codex.
+`~/.config/sciilo-codex/` or the local session managed by Codex.
 
 ## Security and privacy
 
@@ -265,10 +268,17 @@ This command does not remove the configuration stored in
 Install the current LTS version from [nodejs.org](https://nodejs.org/), reopen
 the terminal, and run `node --version` again.
 
-### `sciilo-sidecar: command not found`
+### `sciilo-codex: command not found`
+
+The command was installed outside your `PATH`. Ask npm where it puts global
+commands:
+
+```shell
+npm prefix -g
+```
 
-Run `./install.sh` again. At the end, the installer displays either the command
-path or the line you need to add to your `PATH`.
+The commands live in the `bin` subfolder of that path. Add it to your `PATH`,
+then reopen the terminal.
 
 ### A global `codex` command cannot be found
 
@@ -276,30 +286,36 @@ This is expected: the Codex runtime supplied with the sidecar is private and
 does not need to be in your `PATH`. Use:
 
 ```shell
-sciilo-sidecar status
+sciilo-codex status
 ```
 
 ### The Codex runtime is missing or damaged
 
-Download the repository again and run:
+Reinstall the sidecar:
 
 ```shell
-./install.sh
+npm install -g @sciilo.ai/codex-sidecar@latest
 ```
 
-The installer automatically downloads the Codex package for your platform.
+The installation automatically downloads the Codex package for your platform.
 
 ### Permission error during installation
 
-Do not use `sudo`. Install Node.js for your user account, reopen the terminal,
-and run `./install.sh` again.
+Do not use `sudo`. A global install that asks for administrator rights means
+npm is writing outside your account. Point it at a folder you own:
+
+```shell
+npm config set prefix ~/.local
+```
+
+Add `~/.local/bin` to your `PATH`, reopen the terminal, and install again.
 
 ### Codex is not authenticated
 
 Run:
 
 ```shell
-sciilo-sidecar setup
+sciilo-codex setup
 ```
 
 To use an API key, repeat the commands from option B without writing the key
@@ -310,7 +326,7 @@ directly on the command line.
 Stop every sidecar with `Ctrl+C`, generate a new key in Sciilo, then run:
 
 ```shell
-sciilo-sidecar setup
+sciilo-codex setup
 ```
 
 ### The sidecar does not connect
@@ -319,7 +335,7 @@ Check:
 
 ```shell
 node --version
-sciilo-sidecar status
+sciilo-codex status
 ```
 
 Also make sure the Sciilo address starts with `https://`, except for a local

package/bin/{sciilo-sidecar.js → sciilo-codex.js}

@@ -163,7 +163,7 @@ async function renewConnectionKey(path, config, bridge, reason) {
   console.log('sidecar: click Connect in Sciilo, copy the new key, then paste it here.')
 
   if (!stdin.isTTY || !stdout.isTTY) {
-    console.log(`sidecar: not an interactive terminal; run "sciilo-sidecar setup --config ${path}" instead.`)
+    console.log(`sidecar: not an interactive terminal; run "sciilo-codex setup --config ${path}" instead.`)
     return null
   }
 
@@ -209,9 +209,9 @@ function commandOutput(result) {
 
 function usage() {
   console.log(`Usage:
-  sciilo-sidecar setup [--config path]
-  sciilo-sidecar start [--workspace path] [--config path]
-  sciilo-sidecar status [--workspace path] [--config path]
+  sciilo-codex setup [--config path]
+  sciilo-codex start [--workspace path] [--config path]
+  sciilo-codex status [--workspace path] [--config path]
 
 Without --workspace, the sidecar takes the current directory as the project.
 

package/package.json

@@ -1,16 +1,16 @@
 {
   "name": "@sciilo.ai/codex-sidecar",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "type": "module",
   "description": "Local bridge between Sciilo and Codex App Server",
   "license": "Apache-2.0",
   "bin": {
-    "sciilo-sidecar": "./bin/sciilo-sidecar.js"
+    "sciilo-codex": "./bin/sciilo-codex.js"
   },
   "scripts": {
-    "start": "node ./bin/sciilo-sidecar.js start",
-    "setup": "node ./bin/sciilo-sidecar.js setup",
-    "status": "node ./bin/sciilo-sidecar.js status",
+    "start": "node ./bin/sciilo-codex.js start",
+    "setup": "node ./bin/sciilo-codex.js setup",
+    "status": "node ./bin/sciilo-codex.js status",
     "test": "node --test test/*.test.js",
     "vault:sync": "cp \"${SCIILO_VAULT:-../sidecar/vault/vault.js}\" src/vault.js",
     "test:integration": "node ./scripts/quarkus-smoke.js",
@@ -20,7 +20,7 @@
     "node": ">=22"
   },
   "dependencies": {
-    "@openai/codex": "0.147.0",
+    "@openai/codex": "0.149.0",
     "ws": "^8.18.3"
   },
   "files": [

package/src/banner.js

@@ -8,7 +8,7 @@
  * <p>Two things are deliberately conditional. Colour is dropped unless the
  * output is a terminal that wants it, because a banner is also written to log
  * files and journals, where escape codes are noise. The drawing itself is
- * dropped when the output is not a terminal at all: a piped `sciilo-sidecar`
+ * dropped when the output is not a terminal at all: a piped `sciilo-codex`
  * should print a line one can read and grep, not five lines of blocks.</p>
  */
 

package/src/codex-app-server.js

@@ -39,7 +39,7 @@ export class CodexAppServer extends EventEmitter {
 
     await this.request('initialize', {
       clientInfo: {
-        name: 'sciilo-sidecar',
+        name: 'sciilo-codex',
         title: 'Sciilo Codex Sidecar',
         version: '0.1.0',
       },
@@ -51,7 +51,7 @@ export class CodexAppServer extends EventEmitter {
     this.notify('initialized')
     const account = await this.request('account/read', { refreshToken: false })
     if (account?.requiresOpenaiAuth && !account?.account) {
-      throw new Error('Codex is not authenticated. Run `sciilo-sidecar setup`.')
+      throw new Error('Codex is not authenticated. Run `sciilo-codex setup`.')
     }
   }
 

package/src/config.js

@@ -16,8 +16,8 @@ export const DEFAULT_CODEX_MODEL = 'gpt-5.6-sol'
  */
 export const DEFAULT_REASONING_EFFORT = 'medium'
 
-export const defaultConfigPath = () => process.env.SCIILO_SIDECAR_CONFIG
-  || join(homedir(), '.config', 'sciilo-sidecar', 'config.json')
+export const defaultConfigPath = () => process.env.SCIILO_CODEX_CONFIG
+  || join(homedir(), '.config', 'sciilo-codex', 'config.json')
 
 export function resolveWorkspace(explicit) {
   return resolve(explicit || process.cwd())