Skip to main content
Snippets
ProductivitySourceAPIChangelog

Reference

Settings​

User​

Each person sets these for themselves in Settings.

SettingTypeDefaultWhat it does
Collapse folders by defaultbooleantrueStart each snippet folder collapsed when you open the Snippets panel.
Show commandsbooleantrueShow the first line of each snippet's command under its name.
Always show buttonsbooleantrueKeep the run, copy and edit buttons under each snippet visible. Turn off to show them only on hover.
Confirm before runningbooleanfalseAsk before a command snippet runs in a terminal.
Fill sudo passwordbooleanfalseWhen a snippet runs on a host without a terminal, answer its sudo prompt with the host's sudo password, or its SSH password if none is set.
Open the snippets panel with a terminalbooleanfalseShow the snippets panel when a terminal opens on a host that has it.
Snippets panel sideselect"right"Where the panel sits next to the terminal.
Snippets panel sizenumber360Width, or height at the bottom, in pixels.
Snippets 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
Panel beside the terminalbooleantrueOffer a snippets panel next to this host's SSH terminal.

Environment variables​

Set these on the Termix server, for example under environment: in your compose file. See environment variables for the ones core and other plugins read.

VariableDefaultWhat it does
SNIPPET_EXECUTION_TIMEOUT_SECONDSStop a snippet run on hosts after this many seconds. Unset means no limit.

Permissions​

Give these to roles in Settings, Roles.

PermissionWho has it at firstWhat it allows
snippets.viewuserSee your own snippets, notes and shared snippets.
snippets.createuserCreate new snippets, notes and folders.
snippets.edituserRename or change existing snippets and folders.
snippets.deleteuserDelete snippets and folders.
snippets.shareuserShare snippets and folders with other users or roles.

Actions​

Run these from Operations Center, Automations, the CLI (termix ops), the phone app or the API. See actions.

ActionRuns onRiskInputs
snippets.list
List snippets
The serverRead only
snippets.run
Run a snippet
A hostChangessnippet

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
credentials:readCriticalSee your passwords and keys. It can read the stored secret for any host you can reach.
ssh:connectHighRun commands on your servers. Any command, on hosts you connect it to, with your access.
db:core-refsHighRead core account tables. Can query users, roles and hosts directly from the database.
network:serveMediumAccept connections. It opens a port on the Termix server.
credentials:useMediumConnect to your servers. It cannot see your passwords or keys.
hosts:writeMediumCreate and change hosts. It can add hosts and edit the ones you already have.
events:coreMediumWatch everything happening. Including activity from other users, not just yours.
operations:provideMediumOffer actions. Its actions can be run from Automations, the CLI, the phone app and other places, by people allowed to use them.
db:ownLowStore its own data. Kept in its own tables, separate from other plugins.
ui:surfaceLowAdd its own screens. Tabs, panels and settings you can hide later.
secrets:ownLowStore its own secrets. Encrypted by Termix. The plugin never holds the key.

Services​

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

ProvidesVersionPermission
snippets.access1.0.0snippets.view

API​

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

Platforms​

Linux, Windows, macOS