A dotnet CLI template to start off plugins for the Flow Launcher.
Install the template by running the following command:
dotnet new install Flow.Launcher.Plugin.Template
dotnet new flow-plugin --name SamplePlugin --pluginAuthor YourGithubUsername
for example, to start a plugin for Spotify
with the sp
keyword and a description, you would run:
dotnet new flow-plugin --name Spotify --keyword sp --pluginAuthor MyNameOnGithub --description "a Spotify plugin for Flow-Launcher"
Option | Description |
---|---|
--name |
The name of the plugin. Entering SamplePlugin will be expanded to Flow.Launcher.Plugin.SamplePlugin |
--pluginAuthor |
The username of the author. Will be used as the username in Github links. |
--keyword |
The action keyword of the plugin. Default value is * |
--description |
The description of the plugin that will be used in plugin.json and appear in the UI. |
After generating the source files for your new plugin:
- check the
.csproj
file andplugin.json
to verify the details are correct - optionally, add an icon named
icon.png
inside the project folder - open
Main.cs
and start writing your new plugin
dotnet new uninstall Flow.Launcher.Plugin.Template