https://github.com/flow-launcher/dotnet-template
A dotnet-new template to start off plugins for the Flow Launcher.
https://github.com/flow-launcher/dotnet-template
Last synced: 12 months ago
JSON representation
A dotnet-new template to start off plugins for the Flow Launcher.
- Host: GitHub
- URL: https://github.com/flow-launcher/dotnet-template
- Owner: Flow-Launcher
- License: mit
- Created: 2020-07-03T21:28:34.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-27T20:54:34.000Z (over 1 year ago)
- Last Synced: 2025-07-02T07:09:00.325Z (12 months ago)
- Language: PowerShell
- Size: 55.7 KB
- Stars: 10
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.md
- License: License
Awesome Lists containing this project
README
Flow-Launcher dotnet-new template [](https://ci.appveyor.com/project/JohnTheGr8/dotnet-template)
==================
A dotnet CLI template to start off plugins for the [Flow Launcher](https://github.com/Flow-Launcher/Flow.Launcher).
### Installation
Install the template by running the following command:
dotnet new install Flow.Launcher.Plugin.Template
### Usage
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:
```ps
dotnet new flow-plugin --name Spotify --keyword sp --pluginAuthor MyNameOnGithub --description "a Spotify plugin for Flow-Launcher"
```
### Options
| 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. |
### Next steps
After generating the source files for your new plugin:
- check the `.csproj` file and `plugin.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
### Uninstall
dotnet new uninstall Flow.Launcher.Plugin.Template