Snippets

Snippet is a reusable block of shell scripts that can be saved and then run on Hosts and Connections. Snippets are designed to automate repetitive tasks and reduce the chance of errors.

Package is a collection of related Snippets designed to simplify the navigation and search of relevant commands.

Common use cases for Snippets:

• Execute a snippet in the terminal.

• Run a snippet on multiple Hosts simultaneously.

• Automatically execute a snippet when a connection starts.

• Share Snippets and Packages with the team.

Adding Snippets

1. Choose Snippets in the main menu.

2. Click New snippet at the top.

3. Label field (Optionally) - provide a name for the snippet.

4. Add a package (Optionally) - select a package in which you want to place the snippet.

5. In the Script field, enter a command(s) that should be executed.

6. Click ➔ at the top right to hide the snippet's details.

Running Snippets in the Terminal

Execute a Snippet via Autocomplete

1. Ensure Autocomplete is enabled.

2. Start typing the name of the Snippet.

3. Press the Arrow down to select a Snippet.

4. Press Enter to execute the snippet or Tab to paste it.

Execute a Snippet via Booster

1. In the Terminal, switch to the Snippets tab.

2. Select the Snippet.

3. Click Paste or Run depending on what you want.

Running Snippets on several Hosts

One of the ways to do so is via Booster

1. In the Terminal, switch to the Snippets tab.

2. Right-click the snippet you want to run and click Run in all tabs.

Another way is using the Snippet Screen

1. Choose Snippets in the main menu.

2. Select the Snippet.

3. Choose the hosts and/or groups and click Run.

In the desktop app, a snippet can be executed in all active sessions.

Running Snippet on connection start

1. Select the host where you want to run the snippet, or create a new one.

2. Scroll down to the Startup Command option.

3. Choose the snippet you want to run automatically upon connection.

4. Save the host settings.

Now, whenever you connect to this host, the selected snippet will run automatically at the start of the session.

Organize snippets into packages

A snippet package is a named container for your snippets. You can create one and populate it with snippets on the Snippets screen. The snippet packages you create are displayed at the top of the Snippets screen.

Add a snippet package

1. Choose Snippets in the main menu.

2. Click New package at the New Snippet dropdown.

3. Provide a name for the snippet package and click Save.

Add snippets to a snippet package

To add a single snippet to a snippet package, specify the snippet package in the snippet's properties.
To add several snippets in bulk, use drag and drop.

Remove snippets from a snippet package

To remove a snippet from a snippet package, click Edit. Then, find where the snippet package is assigned and click Remove.