support bot: document add-on override

This commit is contained in:
shum
2026-10-10 12:27:31 +00:00
parent 932388ca32
commit f41595d61e
2 changed files with 4 additions and 1 deletions
+3
View File
@@ -64,6 +64,7 @@ Run `npm start -- --help` for the auto-generated reference. Summary:
|---|---|
| `GROK_API_KEY` | xAI API key; enables Grok replies |
| `SIMPLEX_LIBS_DIR` | directory with a local libsimplex build for the `--db` backend, instead of the downloaded one |
| `SIMPLEX_ADDON_PATH` | locally built Node.js add-on (`simplex.node`), instead of the downloaded one |
## Local development against unreleased lib changes
@@ -71,10 +72,12 @@ This package depends on `simplex-chat` from npm. To test against an in-tree vers
```bash
# In packages/simplex-chat-nodejs
npm install && npm run build
npm link
# In apps/simplex-support-bot
npm link simplex-chat
export SIMPLEX_ADDON_PATH=../../packages/simplex-chat-nodejs/build/Release/simplex.node
```
`npm unlink simplex-chat && npm install` reverts to the registry version.
+1 -1
View File
@@ -53,7 +53,7 @@ function buildCommand(): Command {
.option("--complete-hours <n>", "auto-complete chats after N hours idle (0 disables)", parseNonNegativeInt("--complete-hours"), 3)
.option("--card-flush-seconds <n>", "debounce card state writes", parseNonNegativeInt("--card-flush-seconds"), 300)
.option("--context-file <path>", "text file with Grok system context (required if GROK_API_KEY set)")
.addHelpText("after", "\nEnvironment:\n GROK_API_KEY xAI API key — enables Grok replies\n SIMPLEX_LIBS_DIR local libsimplex build for the --db backend\n")
.addHelpText("after", "\nEnvironment:\n GROK_API_KEY xAI API key — enables Grok replies\n SIMPLEX_LIBS_DIR local libsimplex build for the --db backend\n SIMPLEX_ADDON_PATH locally built Node.js add-on\n")
}
interface RawOpts {