Byte Stash Plugin for FlowLauncher

A powerful FlowLauncher plugin for managing and accessing your code snippets stored in ByteStash directly from your launcher.

Table of Contents

• Byte Stash Plugin for FlowLauncher
  • Installation
    • Prerequisites
    • Install via FlowLauncher
    • Manual Installation
  • Configuration
  • Usage
    • Basic Usage Pattern
    • Available Commands
      • Search Snippets
      • Create Snippets
      • Edit Snippets
      • Delete Snippets
  • Context Menu Actions
  • Troubleshooting
    • Connection Issues
    • Invalid Settings Warning
  • Attributions
  • Contributing
  • Support
  • License
  • Links

Installation

Prerequisites

• FlowLauncher installed on Windows

• A running ByteStash instance (self-hosted or cloud-based)

Install via FlowLauncher

1. Open FlowLauncher

2. Type pm install Byte Stash

3. Press Enter to install the plugin

4. Restart FlowLauncher if prompted

Manual Installation

1. Download the latest release from the GitHub Releases page

2. Extract the ZIP file to your FlowLauncher plugins directory:

   %APPDATA%\FlowLauncher\Plugins\Byte Stash-{version}

3. Restart FlowLauncher

Configuration

After installation, you need to configure the plugin with your ByteStash connection details:

1. Open FlowLauncher Settings (type settings in FlowLauncher)

2. Navigate to the Plugins section

3. Find Byte Stash in the plugin list

4. Configure the following settings:

   Setting	Description
   Base URL	The base URL of your ByteStash instance (e.g., https://bytestash.example.com)
   API Key	Your ByteStash API key for authentication
   Search in Code	Enable this option to search within snippet code in addition to titles and descriptions
   Creation delimiter	The delimiter used when creating new snippets (default is |)

Usage

The plugin is activated using the action keyword stash in FlowLauncher.

Basic Usage Pattern

stash <command> [parameters]

Available Commands

Search Snippets

Search for snippets in your ByteStash collection.

stash q <search term>

• Enter: Copy the first code fragment to clipboard

• Right-click or Shift+Enter: Open context menu with additional actions

Create Snippets

Create new snippets directly from FlowLauncher.

stash + <title> | <description> | <categories> | <code>

Parameter	Description
title	Title of the snippet (required)
description	Description of the snippet (optional)
categories	Comma-separated list of categories (optional)
code	Code content. If omitted, uses clipboard content. Multiple fragments can be separated using |

Edit Snippets

Editing existing snippets is a two-step process:

1. Select the snippet to update

   1. Type stash q <search term> to find the snippet, then right-click or press Shift+Enter on it and select "Edit snippet" from the context menu.

   2. Alternatively, go to the edit mode by typing stash * <search term>, then select the snippet from the results.

2. Update the snippet details

stash * <title> | <description> | <categories> | <code>

Parameter	Description
title	Title of the snippet (required)
description	Description of the snippet (optional)
categories	Comma-separated list of categories (optional)
code	Code content. If omitted, uses clipboard content. Multiple fragments can be separated using |

Delete Snippets

Delete snippets from your ByteStash collection.

1. Search for a snippet using stash q <search>

2. Right-click or press Shift+Enter on the snippet

3. Select "Delete snippet" from the context menu

4. Confirm the deletion

Context Menu Actions

Right-click or press Shift+Enter on any snippet to access:

• Open in ByteStash: Opens the snippet in your ByteStash web interface

• Edit Snippet: Enter edit mode for the selected snippet

• Copy Code (Fragment): Copy individual code fragments (for multi-fragment snippets)

• Delete Snippet: Remove the snippet from your collection

Troubleshooting

Connection Issues

If you experience connection problems:

1. Verify your Base URL is correct and accessible

2. Check your API key is valid

3. Ensure your ByteStash instance is running

4. Check firewall settings if using a self-hosted instance

Invalid Settings Warning

If you see an "Invalid settings" message:

1. Open plugin settings

2. Verify both Base URL and API Key are configured

Attributions

This plugin makes use of the following resources:

• ByteStash: The snippet management system this plugin connects to

• Icons8: Icons used in the plugin interface

Contributing

Contributions are welcome! Please feel free to submit issues or pull requests on the GitHub repository.

Support

For issues, feature requests, or questions, open an issue on GitHub Issues.

License

This project is licensed under the GNU General Public License v3.0 (GPL-3.0).

For more information about the GPL-3.0 license, visit: https://www.gnu.org/licenses/gpl-3.0.html

Links

• FlowLauncher: https://www.flowlauncher.com/

• ByteStash: https://github.com/jordan-dalby/ByteStash

---

Made with ❤️ for the FlowLauncher and ByteStash communities