Skip to main content
AI Assistant
ProductivitySourceAPIChangelog

Reference

Settings​

Admin​

Set by an admin in Settings, under the plugin's name. It applies to everyone.

SettingTypeDefaultWhat it does
AI assistantbooleanfalseLet users turn on the AI assistant. While this is off, the assistant is hidden and blocked for everyone.
Allowed private AI hoststextarea"localhost\n127.0.0.1\n::1\nhost.docker.internal"Hosts on your private network that users may point a provider at, such as a self-hosted Ollama. Put one host on each line.
AI assistant parallel hostsnumber8How many hosts an assistant command runs on at the same time.
AI assistant command timeout (seconds)number120How long a command may run on a host before it is stopped. The assistant can ask for up to 600.
AI assistant output per host (characters)number4000How much of each host's output is kept. Longer output keeps its start and end.
Pause AI auto-opsbooleanfalseStops every AI task and approved plan that is running and refuses new ones, until turned off again.
AI tasks per automation per hournumber6More triggers in the same hour are skipped.
Token budget per AI tasknumber200000A task that uses this many tokens is stopped and reports what it found.
Daily AI token budget per usernumber2000000Once a user has used this many tokens today (UTC), their AI tasks are skipped or stopped.
Collect the asset inventory dailybooleantrueReads every host the collector can connect to once a day with one read-only script.
Asset collection time (UTC)string"03:00"HH:MM, for example 03:00.
Annotate assets after each collectionbooleantrueA model writes each changed asset's role, importance and business system, and the dependencies the facts show.
Token budget per asset annotation runnumber200000A run stops once its model calls have used this many tokens; what it wrote stays.
Exposure history retention (days)number90Keeps pending notices and evidence referenced by current entries regardless of age.

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Enable the AI assistantbooleanfalseLet the assistant read your setup and suggest changes for you to approve.
Allow read-only diagnostic commandsbooleanfalseThe assistant may run a short list of safe commands like df and uptime without asking each time. Anything that changes a server is always proposed first.
Open the assistant panel with a terminalbooleanfalseShow the assistant panel when a terminal opens on a host that has it.
Assistant panel sideselect"right"Where the panel sits next to the terminal.
Assistant panel sizenumber400Width, or height at the bottom, in pixels.
Assistant panel edge buttonbooleantrueShow a small button on the terminal edge to open the panel.

Host​

Set per host in the host editor, on the plugin's tab. Host defaults can set them for many hosts at once.

SettingTypeDefaultWhat it does
Enable AI AssistantbooleanfalseAllow the AI assistant to help in this host's terminal. Off by default, and still needs AI enabled for your account.
Panel beside the terminalbooleantrueOffer a assistant panel next to this host's SSH terminal.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
ai.useuserOpen the assistant and ask it things.
ai.manage_providersuserAdd, edit and remove the AI providers and their API keys.
ai.apply_proposalsuserLet the assistant carry out the changes it suggests.
ai.services.useuser
ai.secrets.shareuser
ai.agentsadminStart coding agents on SSH hosts using configured AI providers. Agents can execute commands and change files as the SSH user.
ai.ops.useadminLet the assistant run any shell command on the hosts you select. Admins only by default.
ai.usage.view_alladminSee the tokens every user's AI calls used, not only your own. Admins only by default.
ai.assets.viewadminSee the collected hosts, guests, containers, zones and connections. Admins only by default.
ai.assets.manageadminStart collections, edit zone rules, pin zones and change the schedule. Collection reads hosts read-only. Admins only by default.

Capabilities​

What the plugin's code is allowed to do. Termix shows this list before you install it. See capabilities for all of them.

CapabilityRiskWhat it means
ssh:connectHighRun commands on your servers. Any command, on hosts you connect it to, with your access.
users:impersonateHighAct as other users. Runs background work with another user's access, such as scheduled jobs. Every use is written to the audit log.
process:spawnHighRun programs on this machine. Programs run on the Termix server itself, not on your hosts.
operations:invokeHighRun other plugins' actions. Acts for the signed-in user on the actions its manifest lists. Approval rules still apply.
network:socketsHighOpen its own network connections. It can listen on ports and connect to any address directly, without Termix checking each connection.
hosts:writeMediumCreate and change hosts. It can add hosts and edit the ones you already have.
credentials:useMediumConnect to your servers. It cannot see your passwords or keys.
network:outboundMediumReach the internet. It can send requests to outside services.
notify:sendMediumSend alerts. To you or other users, and through the channels they set up.
network:serveMediumAccept connections. It opens a port on the Termix server.
users:readMediumSee usernames and roles. Never password hashes, never two factor state.
events:coreMediumWatch everything happening. Including activity from other users, not just yours.
hosts:readLowSee your host list. Names and addresses for hosts you can already see.
db:ownLowStore its own data. Kept in its own tables, separate from other plugins.
secrets:ownLowStore its own secrets. Encrypted by Termix. The plugin never holds the key.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.
files:ownLowStore its own files. In its own folder on disk, separate from other plugins.

Works with other plugins​

Works better with: workspaces ^1.0.0, network-topology ^1.0.0, snippets ^1.0.0, fleets ^1.0.0, ssh-terminal ^1.0.0, automations ^1.0.0, homepage ^1.0.0.

Services​

Services are how plugins call each other. Plugin authors can use these.

ProvidesVersionPermission
ai.tasks1.0.0ai.ops.use
UsesVersionOptional
workspaces.saved^1.0.0yes
network-topology.graph^1.0.0yes
snippets.access^1.0.0yes
fleets.access^1.0.0yes
terminal.history^1.0.0yes
automations.access^1.0.0yes
homepage.items^1.0.0yes

API​

The plugin's HTTP routes are in the API reference.

Platforms​

Linux, Windows, macOS