chore: rework plugin readmes, json changelogs and standalone repo setup

2026-10-30 07:05:24 +00:00 · 2026-10-04 21:25:16 -05:00
1 parent a8f383d2b3
commit 29a946d02e
@@ -1,50 +1,48 @@
-# AI Assistant
+<div align="center">

-An AI assistant that can read your hosts, snippets, fleets, alerts and automations, and suggest changes for you to approve.
+<img src="https://raw.githubusercontent.com/Termix-SSH/Termix/main/public/icon.svg" width="120" height="120" alt="Termix Logo" />
+
+<h1>AI Assistant</h1>
+
+<p>An optional AI assistant that knows your servers</p>
+
+</div>
+
+<br />
+
+## Overview
+
+AI Assistant is a chat that can read your Termix setup and propose changes for you to approve. It can also run coding agents on your SSH hosts.
+
+<br />

 ## Features

- 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.
+- Ask about your hosts, snippets, fleets, alerts, automations and more
+- Proposes changes instead of making them, and nothing runs until you approve it
+- Can run safe read-only commands like `df` and `uptime` if you allow it
+- Ask about a host right from its terminal
+- Works with Ollama, Anthropic, OpenAI, Google Gemini and any OpenAI compatible endpoint
+- Run Pi, OpenCode, Claude Code or Codex as a coding agent on an SSH host, using your own provider

-## Settings
-
-### Admin
-
- 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.
-
-### 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.
+<br />

 ## Services

-Uses from other plugins:
+Uses from other plugins, each one optional:

- `workspaces.saved`, `network-topology.graph`, `snippets.access`, `fleets.access`, `terminal.history`, `automations.access` and `homepage.items` to read your data. Each one is optional.
+- `workspaces.saved`, `network-topology.graph`, `snippets.access`, `fleets.access`, `terminal.history`, `automations.access` and `homepage.items` to read your data

-## Development
+<br />

-```bash
-npm run build      # build into dist/
-npm run test       # run this plugin's tests
-npm run typecheck  # type-check this plugin
-```
+## Support
+
+To report a bug or request a feature, open a [support ticket](https://github.com/Termix-SSH/Support/issues/new/choose). You need to be logged in to GitHub. Please be as detailed as possible, preferably in English.
+
+For discussions and questions, join the [Discord](https://discord.gg/jVQGdvHDrf) server.
+
+<br />
+
+## License
+
+Distributed under the Apache License Version 2.0. See [LICENSE](https://github.com/Termix-SSH/Termix/blob/main/LICENSE) for more information.