snippetpixie(1)

๐Ÿ“ฆ version 1.5.3, in nixos 26.05, nixpkgs unstable

๐ŸŽ€ NAME ๐ŸŽ€

snippetpixie โ€” Your little expandable text snippet helper. This is the snippetpixie(1) page from the General Commands Manual, and it is literally giving โ€œsave your go-to text so it comes back when you need itโ€ main character energy. ๐Ÿ’–


โœจ DESCRIPTION โœจ

Okay so bestie: you save your often used text snippets, and then they expand whenever you type their abbreviation. No cap, itโ€™s that simple.

For example:

"spr`" expands to "Snippet Pixie rules!"

Slay. ๐Ÿฆ‹


๐ŸŒธ SYNOPSIS ๐ŸŒธ

com.github.bytepixie.snippetpixie [--show]

com.github.bytepixie.snippetpixie --search-and-paste

com.github.bytepixie.snippetpixie --start

com.github.bytepixie.snippetpixie --stop

com.github.bytepixie.snippetpixie --autostart={on|off|status}

com.github.bytepixie.snippetpixie --status

com.github.bytepixie.snippetpixie -e|--export filename

com.github.bytepixie.snippetpixie -i|--import filename [--force]

com.github.bytepixie.snippetpixie --version

com.github.bytepixie.snippetpixie -h|--help

๐Ÿ’… OPTIONS ๐Ÿ’…

  • --show โ€” Show Snippet Pixieโ€™s window. This is the default action, periodt.
  • --search-and-paste โ€” Show Snippet Pixieโ€™s quick search and paste window. A default shortcut of Ctrl+` for using the search and replace window is installed on first run. You should change this to your preferred shortcut via Snippet Pixieโ€™s preferences menu or your operating systemโ€™s settings UI or files.
  • --start โ€” Start with no window. Lowkey stealth mode.
  • --stop โ€” Fully quit the application, including the background process. Not just the window, bestie โ€” the whole thing.
  • --autostart={on|off|status} โ€” Turn auto start of Snippet Pixie on login, on, off, or show status of setting.
  • --status โ€” Shows status of the application, exits with status 0 if running, 1 if not. Iconic exit-code behavior fr fr.
  • -e, --export=filename โ€” Export snippets to file.
  • -i, --import=filename โ€” Import snippets from file, skips snippets where abbreviation already exists.
  • --force โ€” If used in conjunction with import, existing snippets with same abbreviation are updated.
  • --version โ€” Display version number.
  • -h, --help โ€” Display help.

๐Ÿงš NOTES ๐Ÿงš

Abbreviations should be short, easy to remember and hard to trigger accidentally. Thatโ€™s the vibe check.

It helps if an abbreviation includes either a key word from the fully expanded text, or an initialization or acronym that is part of it.

For example, if you regularly wrote โ€œSnippet Pixieโ€ ๐Ÿ˜‰ you might use โ€œspโ€.

However, there are a lot of words that include the letter combination โ€œspโ€ (see https://www.wordfind.com/contains/sp/), so thereโ€™s a reasonably high chance that Snippet Pixie would expand that abbreviation when you didnโ€™t want it to. Not me getting betrayed by two little letters. ๐Ÿ˜ญ

So instead itโ€™s common to add a โ€œtrigger characterโ€ to the end of the abbreviation. This is commonly a character that isnโ€™t found in normal sentences such as </kbd> or ~` that is easy to find on your keyboard. Often just appending a space is enough, or doubling up characters.

I personally use </kbd> (commonly known as grav or backtick) a lot as itโ€™s a single keystroke on my British layout keyboard just below my Escape key. So for me <kbd>sp is a natural abbreviation for โ€œSnippet Pixieโ€.

However, I could see using "sp " or "spp" for the abbreviation.

If you do use a trailing space as your trigger character you might find it useful to include a trailing space in the text that is expanded, e.g. "sp " expands to "Snippet Pixie " as itโ€™s more natural when typing.


๐ŸŒˆ LIMITATIONS ๐ŸŒˆ

  • Auto-expansion only works on accessible applications, use the shortcut to open the search and paste window for other applications such as browsers and Electron based apps.
  • Auto-expansion does not work in terminals, but the shortcut method works with terminals that accept Ctrl+v for paste such as the elementary OS terminal.
  • The cursor placeholder is not supported when using the shortcut method rather than auto-expansion.
Okay but for real, these limitations are important โ€” especially the terminal one. Donโ€™t come for Snippet Pixie when auto-expansion dips in terminals. ๐Ÿ’€

๐Ÿซถ SEE ALSO ๐Ÿซถ

snippetpixie-placeholders(5)


๐Ÿ‘‘ AUTHORS ๐Ÿ‘‘

Created and maintained by Ian Jones <ian@ianmjones.com>, supported by Byte Pixie Limited <hello@bytepixie.com> and other generous contributors of skills, time, and funds. Up to date sources can be found at https://github.com/bytepixie/snippetpixie, where bug reports and feature requests may also be submitted.


Source/version page: snippetpixie(1). Date: 2020-08-29. Stay iconic, bestie โ€” mwah ๐Ÿ’‹๐Ÿ’œ

๐Ÿ“ฆ where this page comes from