Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/gnmyt/Nexterm/llms.txt

Use this file to discover all available pages before exploring further.

Nexterm lets you build a personal or shared library of scripts and snippets that you can fire off from any terminal session. Scripts are full executable files — ideal for automation tasks like system maintenance, deployments, or batch operations. Snippets are single commands you can paste into a running session without writing a script file.

​
Scripts vs snippets

Nexterm distinguishes scripts from snippets by file extension, not folder location. This means you can organize your repository however you like, and Nexterm will sort files into the right category automatically.

Scripts

Full executable files that run on the server. Use them to automate multi-step tasks. Supported extensions: .sh, .bash, .zsh, .fish, .ps1

Snippets

Quick commands you paste into an active terminal session. Supported extensions: .snippet, .txt, .cmd

​
File format

Both scripts and snippets use comment-based metadata at the top of the file to supply display information to the Nexterm UI. Three tags are available: @name, @description, and @os. 
# @name: Largest files
# @description: Find the 10 largest files on the system.
# @os: Ubuntu, Debian, Fedora

find / -type f -exec ls -lh {} + | sort -k5 -h | tail -10

​
Metadata tags

TagRequiredDescription
@nameYesDisplay name shown in the Nexterm UI.
@descriptionNoAdditional context about what the command does.
@osNoComma-separated list of compatible operating systems. Nexterm uses this to filter the list when you are connected to a specific host type.
Scripts and snippets without an @os tag are shown regardless of the connected host’s operating system. Add @os only when a command is specific to one or more distributions.

​
Supported @os values

Use these exact values in the @os tag. Multiple values are separated by commas.
ValueNotes
Ubuntu
Debian
Alpine Linux
Fedora
CentOS
Red Hat
Rocky Linux
AlmaLinux
openSUSE
Arch Linux
Manjaro
Gentoo
NixOS
Proxmox VEUse for commands specific to PVE shell or LXC consoles.
Use Proxmox VE for snippets that rely on PVE utilities like vzdump, pvesh, or qm. Those snippets will only appear when you are connected through a Proxmox integration.

​
Using scripts and snippets in a terminal session

Scripts and snippets are accessible from the Snippets panel inside any active terminal session.
1

Open the snippets panel

Click the snippets icon in the terminal toolbar, or open the panel from the session side menu.
2

Select a source

Choose your repository or personal library from the dropdown at the top of the panel.
3

Switch between tabs

Use the Snippets tab for quick paste-commands and the Scripts tab for full executable scripts.
4

Run or paste

Click a snippet to paste its content into the active terminal. Click a script to execute it on the connected server.

​
Searching scripts and snippets

The scripts panel supports search by name and description. Type in the search box to filter the list in real time. The backend searches both the name and description fields, so you can find scripts by what they do, not just what they are called.

​
Personal vs organization scripts

Scripts and snippets can be personal (visible only to you) or organization-scoped (shared with every member of an organization).
  • Personal scripts are stored with your account and not visible to other users.
  • Organization scripts are visible to all members of that organization.
  • Source-synced scripts (pulled from a Git repository) cannot be edited, deleted, or reordered from the UI. You must make changes in the source repository instead.

​
Reordering scripts

You can drag scripts and snippets to change the order in which they appear in the panel. Source-synced items cannot be reordered.

​
Next steps

Scripting variables and directives

Add interactive prompts, progress bars, confirmation dialogs, and structured output to your scripts using @NEXTERM: directives.

Custom sources

Connect a Git repository to sync scripts and snippets automatically into Nexterm.

Build docs developers (and LLMs) love

Get started for freeTalk to us