@scalableweb/companion 0.3.0 → 0.3.1

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 CHANGED
@@ -9,8 +9,8 @@ Use Node.js 24 or 26.
9
9
  Registry installation uses the pinned version:
10
10
 
11
11
  ```sh
12
- npx --yes @scalableweb/companion@0.3.0 setup
13
- npx --yes @scalableweb/companion@0.3.0 start
12
+ npx --yes @scalableweb/companion@0.3.1 setup
13
+ npx --yes @scalableweb/companion@0.3.1 start
14
14
  ```
15
15
 
16
16
  Version 0.2.0 uses the previous pairing contract and cannot connect to the updated website.
@@ -27,7 +27,7 @@ npm run companion -- setup
27
27
  npm run companion -- start
28
28
  ```
29
29
 
30
- The examples below use the registry package; from the checkout, replace `npx --yes @scalableweb/companion@0.3.0` with `npm run companion --`.
30
+ The examples below use the registry package; from the checkout, replace `npx --yes @scalableweb/companion@0.3.1` with `npm run companion --`.
31
31
 
32
32
  Guided setup offers notebook-only use, Codex with ChatGPT sign-in, Codex with an OpenAI API key, direct API keys, and a local model in LM Studio.
33
33
  It guides authentication and model selection, saves your origin/port preferences and prints the exact start command.
@@ -59,8 +59,8 @@ Public catalogs can be read without a valid key, so successful listing alone doe
59
59
  For scripts, use a key already supplied through your environment:
60
60
 
61
61
  ```sh
62
- npx --yes @scalableweb/companion@0.3.0 setup --api --api-provider openai --model '<exact-model-id>' --api-key-env OPENAI_API_KEY
63
- npx --yes @scalableweb/companion@0.3.0 start
62
+ npx --yes @scalableweb/companion@0.3.1 setup --api --api-provider openai --model '<exact-model-id>' --api-key-env OPENAI_API_KEY
63
+ npx --yes @scalableweb/companion@0.3.1 start
64
64
  ```
65
65
 
66
66
  The named `--api-provider` choices are `openai`, `anthropic`, `gemini` and `openrouter`.
@@ -93,7 +93,7 @@ For explicit ChatGPT setup, use `setup --codex`, then `login`.
93
93
  For explicit API key setup, use `setup --codex`, then pipe the key:
94
94
 
95
95
  ```sh
96
- printenv OPENAI_API_KEY | npx --yes @scalableweb/companion@0.3.0 login --with-api-key
96
+ printenv OPENAI_API_KEY | npx --yes @scalableweb/companion@0.3.1 login --with-api-key
97
97
  ```
98
98
 
99
99
  Setting that variable alone does not authenticate the dedicated profile.
@@ -103,8 +103,8 @@ See [OpenAI's authentication guide](https://learn.chatgpt.com/docs/auth) for the
103
103
  Start LM Studio's server, load a model, then choose local setup or run:
104
104
 
105
105
  ```sh
106
- npx --yes @scalableweb/companion@0.3.0 setup --local --local-url http://127.0.0.1:1234/v1 --model google/gemma-4-12b-qat
107
- npx --yes @scalableweb/companion@0.3.0 start
106
+ npx --yes @scalableweb/companion@0.3.1 setup --local --local-url http://127.0.0.1:1234/v1 --model google/gemma-4-12b-qat
107
+ npx --yes @scalableweb/companion@0.3.1 start
108
108
  ```
109
109
 
110
110
  Replace the verified Gemma example with your loaded model's exact identifier.
@@ -115,7 +115,7 @@ LM Studio is the first verified runner; Ollama, llama.cpp and Windows remain unv
115
115
 
116
116
  ## Check and retain your work
117
117
 
118
- Stop the companion and run `npx --yes @scalableweb/companion@0.3.0 doctor` for checks, or add `--json` for a diagnostic report you choose whether to share.
118
+ Stop the companion and run `npx --yes @scalableweb/companion@0.3.1 doctor` for checks, or add `--json` for a diagnostic report you choose whether to share.
119
119
  The report identifies the saved provider choice, storage, origin/port and prerequisite results without credentials, notes, conversations, remote provider diagnostics or connection tokens.
120
120
  Codex is optional in notebook-only, direct API and local-model modes.
121
121
  Use `doctor --codex` to require its installation and dedicated-profile sign-in; diagnostics do not change the saved provider choice.
@@ -131,7 +131,7 @@ Restore your records and sign in again on another computer; a relocated Codex pr
131
131
  To migrate a notebook, stop its companion/provider and select a new empty destination:
132
132
 
133
133
  ```sh
134
- npx --yes @scalableweb/companion@0.3.0 migrate --from /absolute/path/to/old-notebook --directory /absolute/path/to/new-notebook --confirm-stopped
134
+ npx --yes @scalableweb/companion@0.3.1 migrate --from /absolute/path/to/old-notebook --directory /absolute/path/to/new-notebook --confirm-stopped
135
135
  ```
136
136
 
137
137
  Migration retains the source and rejects a nonempty destination.
@@ -140,7 +140,7 @@ Setup preferences are left for explicit setup in the destination.
140
140
  Choose the original provider/endpoint/model/tool mode to resume conversations, restore any key environment variable, and run `doctor` with the destination directory.
141
141
  An unsupported newer database schema is rejected without rewriting it.
142
142
 
143
- `npx --yes @scalableweb/companion@0.3.0 logout` removes the selected API endpoint's OS entry or uses Codex's keyring logout; it retains notebook and conversation records.
143
+ `npx --yes @scalableweb/companion@0.3.1 logout` removes the selected API endpoint's OS entry or uses Codex's keyring logout; it retains notebook and conversation records.
144
144
  Same-machine API notebook copies with the same credential identity share that keychain entry.
145
145
  Environment-backed API logout explains how to unset or revoke the external key without changing the parent environment.
146
146
 
package/dist/companion.js CHANGED
@@ -16,7 +16,7 @@ import { Writable } from "node:stream";
16
16
  /** Release and connection metadata, independent of a provider or rendering. */
17
17
  var companionRelease = {
18
18
  name: "@scalableweb/companion",
19
- version: "0.3.0",
19
+ version: "0.3.1",
20
20
  protocol: 2,
21
21
  notebookSchema: 1,
22
22
  conversationSchema: 1,
@@ -499,7 +499,7 @@ function learningCodexEnvironment(home) {
499
499
  }
500
500
  Object.assign(env, {
501
501
  CODEX_HOME: home,
502
- HOME: home,
502
+ HOME: process.platform === "darwin" ? process.env.HOME ?? home : home,
503
503
  USERPROFILE: home
504
504
  });
505
505
  return env;
@@ -5112,7 +5112,7 @@ async function configureLearningApi(options) {
5112
5112
  }
5113
5113
  //#endregion
5114
5114
  //#region scripts/lib/learning-cli.ts
5115
- var sourceRevision = "40444f713fa1ae4ceb22eb0b28accf0f7689798a";
5115
+ var sourceRevision = "20e05c0329bdbcf4dbcdc4916fc10da2b38004af";
5116
5116
  async function checkLearningPort(port) {
5117
5117
  const server = createServer();
5118
5118
  try {
package/dist/release.json CHANGED
@@ -1,12 +1,12 @@
1
1
  {
2
2
  "name": "@scalableweb/companion",
3
- "version": "0.3.0",
3
+ "version": "0.3.1",
4
4
  "protocol": 2,
5
5
  "notebookSchema": 1,
6
6
  "conversationSchema": 1,
7
7
  "localProviderSchema": 1,
8
8
  "apiProviderSchema": 1,
9
9
  "codexVersion": "0.154.0",
10
- "sourceRevision": "40444f713fa1ae4ceb22eb0b28accf0f7689798a",
10
+ "sourceRevision": "20e05c0329bdbcf4dbcdc4916fc10da2b38004af",
11
11
  "dirty": false
12
12
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@scalableweb/companion",
3
- "version": "0.3.0",
3
+ "version": "0.3.1",
4
4
  "description": "Private local notebook and student-agent companion for scalableweb.dev",
5
5
  "type": "module",
6
6
  "license": "MIT",