Quick Start

Quick Start

This is your first five minutes with Snipdeck. By the end you'll have copied a resolved command and run one in the live terminal.

First run

The first time Snipdeck launches it seeds a single demo CLI called Examples, containing a handful of representative Snips (a mix of Text and Choice parameters, some tags, a favourite). Use it to find your feet, then delete it once you're oriented — Snipdeck won't recreate it.

A tour of the window

• Title bar — a search box (autocompletes Snip titles in the current scope) and the CLI switcher dropdown. The switcher's top entry, All / Home, is the home launcher; selecting a CLI shows that CLI's Snips.
• Left pane — the tag list for the current scope (single-select; see Tags and Tag Icons), and footer entries: Shared parameters, Tags, Trash, History and Settings.
• Content area — the home launcher (CLI cards + your Most used / Recent / Favourite Snips) or, when a CLI is selected, that CLI's Snip list.

Create a CLI and a Snip

1. On Home, click the New CLI tile at the end of the CLI carousel. Give it a name (for example git) and save. (Icon and execution settings are optional — see Managing CLIs.)
2. With the new CLI selected, click New snip. Give it a title, a command template with {token} placeholders, and define the parameters those tokens map to. For example:
   • Title: Checkout branch
   • Command template: git checkout {branch}
   • Parameter: branch (Text)
3. Save. The Snip appears as a card with a monospace preview of its template.

See Creating and Editing Snips and Parameters and Shared Parameters for the full detail.

Copy a resolved command

1. On a Snip card, click Copy.
2. Fill in the parameters. The preview updates live, and Copy enables once every {token} is resolved.
3. Click Copy — the resolved command is on your clipboard, ready to paste anywhere.

More in Copying Commands.

Run a command

1. On a Snip card, click Run.
2. Fill in the parameters, then review the dry-run preview — it shows the exact resolved command, the shell it will run in, and the working directory.
3. Click Run. The command executes in an embedded terminal you can watch and type into; an exit-code badge and elapsed time appear when it finishes.

Running uses the CLI's configured shell (Windows PowerShell by default). To run a real tool you'll usually set the CLI's shell and, optionally, its executable path and working directory — see Managing CLIs and Running Commands.

Every run is saved to Run History, where you can search past runs, replay them in colour, or run them again.

Next steps

• Tidy your navigation with Tags and Tag Icons.
• Share common parameters across a CLI in Parameters and Shared Parameters.
• Set a convenient summon shortcut in Global Hotkey and System Tray.
• Migrating from SnipCommand? See Importing from SnipCommand.