snippet

Tiny cross-platform widget to insert snippets into the terminal, editor, etc.

Usage

1. Alt + q to show widget
2. Start typing in search box to find snippet (fuzzy search)
3. Use up and down arrows to navigate search results
4. Press enter to choose snippet. Widget disappears and snippet is typed in active window.
5. Press escape to cancel search and hide widget again.
6. Press Alt + F4 while widget is active to close it for good.

Snippets are stored in snippet.yml file, see snippet_sample.yml.
Snippets are automatically reloaded when snippet.yml changes.
If editor_cmd is configured, Alt + e will open the snippet.yml with the given editor command.

Optional configuration is stored in config.yml file, see config_sample.yml.

Snippet arguments

Snippets can use arguments that you have to fill out before it is typed. In this case:

1. When you press enter to select a snippet with arguments, a new window pops up to fill out the arguments.
2. Use up and down arrows to jump between argument inputs
3. Press enter to confirm the arguments and type the snippet. Any empty arguments lead to empty replacements in the snippet.
4. Press escape to cancel and return to the main snippet window.

Automatic snippet arguments

Besides the default arguments which require user input, you can declare certain automatically resolved arguments. For example to use the current date in the snippet.

See the snippet_sample.yml for configuring a snippet with arguments.

Secret snippets

Disclaimer: snippet is nowhere close to a proper password manager. Do not use it for important/personal passwords.

snippet can also type secrets, like a passphrase for a store.

• Secret snippets are encrypted with passwords in snippets.yml. Encryption uses the same approach as Ansible Vaults.
• You will be asked to provide the password when using a secret snippet
• Once you used a secret snippet, you can reuse it without typing the password for a while.
• If you don't use the secret snippet for a while, it will be locked again and require the password. The duration is configurable, see config_sample.yml.

You can create encrypted secrets using the command-line:

1. Run ./snippet --encrypt
2. Enter the secret and a password to encrypt it
3. Add the encrypted value to snippets.yml. See snippet_sample.yml.

Misc. snippet features

See snippet_sample.yml for some smaller options and flags for snippets.

Installation

In general, all you need is the executable from the Releases page. There are some special cases:

• For the "copy/paste snippet" feature on Linux, you need xsel or xclip.
  To build and install xclip manually:

  git clone https://github.com/astrand/xclip.git
  cd xclip/
  ./bootstrap 
  ./configure
  make
  sudo make install

Development

make build-linux
make build-windows
make test
make lint

See Makefile's install-sys-packages for required system packages for compilation.