Overview

Usage

$ snipkit -h
Snipkit helps you to execute scripts saved in your favorite snippets manager without even leaving the terminal.

Usage:
  snipkit [flags]
  snipkit [command]

Available Commands:
  browse      Browse all snippets without executing them
  completion  Generate the autocompletion script for the specified shell
  config      Manage your snipkit configuration file
  copy        Copies the snippet to the clipboard
  exec        Execute a snippet directly from the terminal
  export      Exports snippets on stdout
  help        Help about any command
  info        Provides useful information about the snipkit configuration
  manager     Manage the snippet managers snipkit connects to
  print       Prints the snippet on stdout
  sync        Synchronizes all snippet managers


Flags:
  -c, --config string      config file (default "/Users/pse/Library/Application Support/snipkit/config.yaml")
  -h, --help               help for snipkit
  -l, --log-level string   log level used for debugging problems (supported values: trace,debug,info,warn,error,fatal,panic) (default "panic")
  -v, --version            version for snipkit

Use "snipkit [command] --help" for more information about a command.

Init a config file

Upon first usage, you have to create a config file.

Create a new config file

snipkit config init

Edit the config file manually

SnipKit has a lot more configuration options. Please see Configuration if you encounter problems or want to modify the behavior.

As of now, no external snippet manager is configured.

Add an external snippet manager

snipkit manager add

You will be presented with a list of supported managers. Pick the one you want to use. After that, you should be ready to go.

Different manager need different configuration

Every manager has unique configuration options. Have a look at Managers for more information.

Snippet Commands

Execute snippets

Execute a snippet

snipkit exec

Confirm commands

If you want to confirm a command before execution (with all parameters being resolved) add the flag --confirm:

snipkit exec --confirm

Snpkit will print the command on stdout and ask you to explicitly confirm its execution.

Print snippet on stdout

If you want to print the command that is executed add the flag -p or --print.

Execute a snippet directly by ID

A snippet can be executed directly without selecting it via the UI. See Execute snippet by ID

Print snippets

You can print snippets to stdout without executing them.

Print a snippet

snipkit print

Print and copy snippet

Use snipkit print --copy to print the snippet and copy it to the clipboard at the same time.

Print snippet by ID

The print command also supports the id and param flags. See Execute snippet by ID.

Browse snippets

You can browse all available snippets without executing or printing them.

Browse all snippets

snipkit browse

Copy snippet to clipboard

You can copy a snippet to the clipboard in two ways:

Copy to clipboard

snipkit copy # Copies the snippet directly to the clipboard without printing
snipkit print --copy # Prints the snippet on stdout and, additionally, copies it to the clipboard

Execute snippet by ID

SnipKit allows you to execute a snippet directly by providing the snippet ID and, if required, parameter values via the id and param flag, e.g.:

snipkit exec --id c3BsIzFBMUM5RDI2LTJCMDYtNDk5Mi1BRjA0LTZGREQ0RkNCQUU2MQ== --param VAR1=example-value --param VAR2="other value"

Use snipkit print --args to print the snippet ID and all parameter flags instead of the snippet itself (can be combined with the --copy flag).

Export snippets

$ snipkit export -h

Exports all snippets on stdout as JSON including parsed meta information like parameters.

Usage:
  snipkit export [flags]

Flags:
  -f, --fields strings   Fields to be exported (default [id,title,content,parameters])
  -o, --output string    Output format. One of: json,json-pretty,xml (default "json")

The number of exported fields can be limited with the --fields flag. For example snipkit export --fields=title,content -o json-pretty results in an export like

{
  "snippets": [

    {
      "title": "List files in directory",
      "content": "ls -l"
    },
    {
      "title": "Check system uptime",
      "content": "uptime"
    }
  ]
}