friend-assistant 0.1.44 → 0.1.45
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 +4 -1
- package/dist/BUILD.json +2 -2
- package/dist/friend.mjs +616 -108
- package/dist/web/assets/{index-D6qxQkPK.js → index-BrLi-8KB.js} +23 -23
- package/dist/web/index.html +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -91,7 +91,8 @@ Every command starts with `friend`. If you run Friend from the source code, writ
|
|
|
91
91
|
| `friend daemon stop` | Stops the background Friend and the speech engine with it. | Shutting it down. |
|
|
92
92
|
| `friend daemon restart` | Stops it and starts it again. | After changing a setting such as `friend lan on` or a different model. |
|
|
93
93
|
| `friend daemon status` | Says whether the background Friend is running, for how long, and at which address. Exit code 0 when running, 1 when not. | Checking, or in a script. |
|
|
94
|
-
| `friend upgrade` | Updates Friend in one go: checks npm for the newest version, stops the background Friend, installs it, and starts it again. Add `--force` to reinstall the same version. If Friend runs in a terminal instead, it asks you to press Ctrl+C there first. | A new version is out. |
|
|
94
|
+
| `friend upgrade` | Updates Friend in one go: checks npm for the newest version, stops the background Friend, installs it, and starts it again. Add `--force` to reinstall the same version. If Friend runs in a terminal instead, it asks you to press Ctrl+C there first. (`--auto` is what Friend itself runs to update itself; it writes what happened to `update.log` in the data folder.) | A new version is out. |
|
|
95
|
+
| `friend autostart on` / `off` / `status` | Starts Friend by itself in the background when you sign in to this computer, so you never start it by hand after a restart. Windows: a hidden entry in your sign-in list; macOS: a launch agent; Linux: a user service (or an autostart entry when there is no user systemd). Only your own account's files are touched. `on` can be undone with `off`. | You want Friend always there after a restart. (Settings → Startup and updates does the same.) |
|
|
95
96
|
| `friend lan` (or `friend lan status`) | Shows what Friend listens on and the addresses to open. | Checking, or finding the address for your phone. |
|
|
96
97
|
| `friend lan on` | Lets other devices on your network open Friend. Prints the addresses and the things to know (plain http, no microphone on other devices, firewall prompt). | Using Friend from a phone or another PC. |
|
|
97
98
|
| `friend lan on --https` | The same, with a secure `https://` address (Friend makes its own certificate), so a phone may use the microphone and camera. | Talking to Friend from a phone. |
|
|
@@ -138,6 +139,7 @@ Connectors (Gmail, Chrome control, any MCP service) are managed inside the app,
|
|
|
138
139
|
| `ollama.url`, `ollama.model`, `ollama.vision`, `ollama.contextTokens` | The local model: server address, model name, whether it can see pictures, and how much it remembers at once. |
|
|
139
140
|
| `openai.url`, `openai.model`, `openai.apiKey`, `openai.vision` | An OpenAI-compatible server: its address (ending in `/v1`), the model name it knows, its API key (or empty), and whether the model can see pictures. For OmniRoute (https://github.com/diegosouzapw/OmniRoute) run `npm install -g omniroute` and `omniroute`, then `friend config set provider openai` (the defaults are OmniRoute's: `http://localhost:20128/v1` and model `auto`). Also works with LM Studio, LiteLLM, vLLM and OpenRouter. |
|
|
140
141
|
| `voice.hindiVoice`, `voice.marathiVoice` | The voices that read Hindi and Marathi (Devanagari) text: `hi_IN-priyamvada-medium`, `hi_IN-pratham-medium`, `hi_IN-rohan-medium`, `mr_IN-google-medium`. Empty makes the main voice read that language. See "Hindi, Marathi and English together". |
|
|
142
|
+
| `updates.auto` | Look for a newer Friend shortly after it starts and every few hours, and install it by itself while Friend is not busy (only a Friend running in the background restarts itself). Off: Friend only tells you a new version is out, and you run `friend upgrade` or press Update now in Settings → Startup. |
|
|
141
143
|
| `voice.enabled`, `voice.sttModel`, `voice.ttsVoice`, `voice.language`, `voice.speakTyped`, `voice.duck`, `voice.duckPercent`, `voice.accept`, `voice.challenge` | Speech on or off, the listening model, the speaking voice, a forced language, speaking typed replies, turning music and video down while you talk and while Friend speaks (and how far, in percent), and the two thresholds for recognising your voice. |
|
|
142
144
|
| `bind`, `port` | Where Friend listens (easier: `friend lan`). |
|
|
143
145
|
| `https` | `true` serves a secure `https://` address with a certificate Friend makes for itself, so a phone may use the microphone (easier: `friend lan https on`). |
|
|
@@ -151,6 +153,7 @@ Example: `friend config set voice.speakTyped false` keeps typed messages silent.
|
|
|
151
153
|
| Variable | Meaning |
|
|
152
154
|
|---|---|
|
|
153
155
|
| `FRIEND_HOME` | The folder where Friend keeps its data (default: `.friend` in your home folder). Use another folder to keep a separate test copy. |
|
|
156
|
+
| `FRIEND_DAEMON` | Set to `1` by `friend daemon start` for the Friend it starts in the background. Only a background Friend may restart itself to install an update; one running in a terminal never does. You do not set it yourself. |
|
|
154
157
|
| `FRIEND_ANTHROPIC_KEY` | An API key to use when none is saved. |
|
|
155
158
|
| `FRIEND_PYTHON` | The Python program to use for voice, if the usual ones are not the right version. |
|
|
156
159
|
| `FRIEND_WEB_DIR`, `FRIEND_PLUGIN_CATALOG`, `FRIEND_VOICE_DIR`, `FRIEND_CHROME_CONTROL` | Where the web app, the bundled plugins, the Python voice code and the Chrome control program (its `index.js`) are, for unusual installs. |
|
package/dist/BUILD.json
CHANGED