Snipline Docs

Search

By default Snipline searches the name, command, alias, and tags for a match against your search term. As of 0.7.0 Snipline uses Lunr.js for searching.

With that in mind you can use the following syntax to search:

Searching specific attributes

The following attributes can be searched

For example, you can search for all of the snippets that are tagged sql like this.

1
tags:sql

Another example, you want to search documentation that contains the word Linux or unix, you could do the following

1
docs:*nix

More example searches

Search for snippet that contains git but not log

1
git -log

Search for a curl command that must include auth

1
command:curl +auth*

Search for misspelled or uncertain text

1
2
magneto~1
# results matching magento

Escaping search syntax

When you wish to search dashes (-) or other characters that are used in the Lunr search syntax you can use a backslash (\) before the character you wish to keep.

1
git \-\-log

More information

For more information on using Lunr, check out their searching documentation.

Found an issue with our documentation? Submit an issue/pull request!