mirror of
https://github.com/Termix-SSH/Termix.git
synced 2026-10-30 07:05:24 +00:00
chore: simplify plugin readmes, changelogs and manifest descriptions
This commit is contained in:
1 parent
7423e33184
commit
8043d6dbdd
96 files changed
+1147
-722
No files matched your search
+44
-14
@@ -1,22 +1,52 @@
|
||||
# AI Assistant
|
||||
|
||||
An AI assistant that can read your hosts, snippets, fleets, alerts and automations, and propose changes for you to approve.
|
||||
An AI assistant that can read your hosts, snippets, fleets, alerts and automations, and suggest changes for you to approve.
|
||||
|
||||
Bundled with Termix and enabled by default.
|
||||
## Features
|
||||
|
||||
## Layout
|
||||
- Chat with an assistant that can read your hosts, snippets, fleets, alerts, automations, workspaces, network graph and homepage.
|
||||
- The assistant suggests changes, and nothing is applied until you approve it.
|
||||
- Can run read-only diagnostic commands on a host if you allow it.
|
||||
- Open the assistant from the terminal toolbar with the current session as context.
|
||||
- Works with Ollama, Anthropic, OpenAI, Google Gemini and any OpenAI compatible provider.
|
||||
|
||||
manifest.json id, capabilities and what this plugin contributes
|
||||
src/backend/ activate(ctx) / deactivate(), plus the routes
|
||||
src/frontend/ the UI it registers
|
||||
locales/en.json its strings (English only; the rest are translated)
|
||||
tests/backend/ vitest, node
|
||||
tests/frontend/ vitest, jsdom
|
||||
## Settings
|
||||
|
||||
## Commands
|
||||
### Admin
|
||||
|
||||
npm run build bundle into dist/
|
||||
npm run test run this plugin's tests
|
||||
npm run typecheck
|
||||
- AI assistant: let users turn the assistant on. While this is off it is hidden for everyone.
|
||||
- Allowed private AI hosts: hosts on your private network a provider may point at, such as a self-hosted Ollama.
|
||||
|
||||
See packages/plugin-sdk/ARCHITECTURE.md for the contract this follows.
|
||||
### User
|
||||
|
||||
- Enable the AI assistant: turn the assistant on for yourself.
|
||||
- Allow read-only diagnostic commands: let the assistant run safe commands on your hosts.
|
||||
- Providers: the AI providers, models and API keys you use.
|
||||
|
||||
### Host
|
||||
|
||||
- Enable AI Assistant: allow the assistant to work with this host.
|
||||
|
||||
## Permissions
|
||||
|
||||
- `ai.use`: Open the assistant and ask it things. Admins and users have it by default.
|
||||
- `ai.manage_providers`: Add, edit and remove AI providers and their API keys. Admins and users have it by default.
|
||||
- `ai.apply_proposals`: Let the assistant carry out the changes it suggests. Admins and users have it by default.
|
||||
- `ai.services.use`: Let other features call the assistant for you. Admins and users have it by default.
|
||||
- `ai.secrets.share`: Let other features use the stored AI API key without seeing it. Admins and users have it by default.
|
||||
|
||||
## Services
|
||||
|
||||
Uses from other plugins:
|
||||
|
||||
- `workspaces.saved`, `network-topology.graph`, `snippets.access`, `fleets.access`, `terminal.history`, `automations.access` and `homepage.items` to read your data. Each one is optional.
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
npm run build # build into dist/
|
||||
npm run test # run this plugin's tests
|
||||
npm run typecheck # type-check this plugin
|
||||
```
|
||||
|
||||
See `packages/plugin-sdk/ARCHITECTURE.md` for the plugin contract.
|
||||
Reference in new issue
Block a user