Skip to content

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
  exec        Execute a snippet directly from the terminal
  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

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

Print a snippet
snipkit print
Just browse the available snippets without doing anything
snipkit browse
Execute a snippet
snipkit exec