behackl/pi-unigpt
Watch
1
0
Fork
You've already forked pi-unigpt
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README: no claims about how API keys are issued or revoked
Some checks failed
CI / test (22) (push) Failing after 28s
Details
CI / test (24) (push) Failing after 31s
Details

Browse source
This commit is contained in:
Benjamin Hackl 2026-11-03 21:12:30 +01:00
commit 6f2f924144
1 changed files with 5 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -10,8 +10,7 @@ streaming responses, and image input all work.
## What you need ## What you need
- **pi 1.3 or newer** ([installation guide](https://pi.dev)) - **pi 1.3 or newer** ([installation guide](https://pi.dev))
- **A uniGPT API key.** If you don't have one, ask the uniGPT team at the - **A uniGPT API key**
[IDea_Lab](https://idea-lab.uni-graz.at/en/digital-innovation-lab/unigpt-and-studigpt).
## Setup ## Setup
@ -55,7 +54,7 @@ That's it. Pi remembers your key and your last model for next time.
| `/login unigpt` | Save your API key (or replace it with a new one) | | `/login unigpt` | Save your API key (or replace it with a new one) |
| `/model` | Choose a model | | `/model` | Choose a model |
| `/unigpt-refresh` | Reload the list of models, e.g. after uniGPT adds new ones | | `/unigpt-refresh` | Reload the list of models, e.g. after uniGPT adds new ones |
| `/logout` | Remove your key from pi (the key itself stays valid) | | `/logout` | Remove your key from pi |
## Updating ## Updating
@ -66,8 +65,8 @@ pi update --extensions
## Logging out and uninstalling ## Logging out and uninstalling
**To remove your API key,** type `/logout` and choose uniGPT. The uniGPT **To remove your API key,** type `/logout` and choose uniGPT. The uniGPT
models disappear from `/model` until you log in again. The key itself stays models disappear from `/model` until you log in again. This only removes the
valid; to revoke it, contact the uniGPT team. key from pi; it does not revoke the key at uniGPT.
**To uninstall the extension,** log out first (uninstalling does not delete **To uninstall the extension,** log out first (uninstalling does not delete
the saved key), then run: the saved key), then run:
@ -91,7 +90,7 @@ If you made uniGPT your default, also remove `defaultProvider` and
- **No uniGPT models in `/model`:** type `/unigpt-refresh`. It tells you - **No uniGPT models in `/model`:** type `/unigpt-refresh`. It tells you
what is wrong, e.g. a rejected key or no network connection. what is wrong, e.g. a rejected key or no network connection.
- **One model always fails with an error:** that model may be unavailable - **One model always fails with an error:** that model may be unavailable
on uniGPT's side. Pick another one and let the uniGPT team know. on uniGPT's side. Pick another one.
- **`pi -p "…"` says a uniGPT model was not found:** start pi normally once - **`pi -p "…"` says a uniGPT model was not found:** start pi normally once
after logging in, so it can load the model list. after logging in, so it can load the model list.
- **Installation fails with `spawn npm ENOENT`:** you use pnpm instead of - **Installation fails with `spawn npm ENOENT`:** you use pnpm instead of