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.

Custom sources let you bring your own Git repository into Nexterm so that its scripts and snippets appear alongside the built-in ones. Any public repository hosted on GitHub, GitLab, or any other Git hosting platform is supported. This makes it easy to share a common library of automation scripts across your team without duplicating content inside Nexterm itself.

​
What custom sources provide

A custom source is a Git repository that follows the Nexterm scripts and snippets file format. Once connected, Nexterm pulls the repository content at startup and makes it available in the Snippets panel and the Scripts tab of the terminal.

Scripts

Runnable shell scripts that you can execute directly in an open SSH session with a single click.

Snippets

Reusable text fragments — commands, config blocks, or any other text — that you can paste into a terminal at any time.
See Scripts & Snippets for the file format and directory structure your repository must follow.

​
Supported Git hosting

Custom sources work with any public Git repository. Examples include:
  • https://github.com/your-org/nexterm-scripts
  • https://gitlab.com/your-org/nexterm-scripts
  • Any self-hosted Git server that serves repositories over HTTPS
Private repositories are not supported. The repository must be publicly accessible without authentication.

​
Adding a source

1

Open source settings

Go to Settings → Sources.
2

Add a new source

Click Add to open the new source dialog.
3

Enter a name and repository URL

Give the source a descriptive name — this is only used for display in the UI — and paste the repository URL.
Name:  My Team Scripts
URL:   https://github.com/your-org/nexterm-scripts
4

Save

Click Save. Nexterm registers the source. The repository content will be available after the next startup.
You can add as many sources as you need. Organizing them by project or team — for example, one repository per environment or department — keeps large script libraries manageable.

​
How syncing works

Nexterm syncs each custom source once, when the server starts. After the initial sync, the repository contents are cached locally and served directly from that cache. To pick up changes you push to your repository, restart Nexterm: 
docker restart nexterm
Keep your repository organized and commit changes in logical batches. Because syncing happens at startup, a clean commit history makes it easy to reason about which version of your scripts is currently active in Nexterm.

​
Using scripts and snippets from custom sources

Once a source is synced, its content is accessible from the same places as the built-in library.
1

Open a session

Connect to any server to open a terminal session.
2

Open the Snippets panel

Click the Snippets icon in the session toolbar. Use the repository dropdown to select your custom source and browse or search its snippets.
3

Switch to Scripts

Click the Scripts tab in the same panel to see the scripts from your custom source. Click a script to run it in the active session.

Build docs developers (and LLMs) love

Get started for freeTalk to us