Flow.Launcher/README.md

115 lines
7.1 KiB
Markdown
Raw Normal View History

2020-06-26 10:24:28 +00:00
<p align="center">
2020-12-14 20:17:19 +00:00
<a href="https://flow-launcher.github.io">
<img width="500px" src="https://github.com/Flow-Launcher/Flow.Launcher/blob/5ba4514f31e624c679628d4dfe89036c0e24006c/Doc/Logo/resources/flow-header-square-transparent.png">
</a>
2020-06-26 10:24:28 +00:00
</p>
2021-02-18 21:44:36 +00:00
![Maintenance](https://img.shields.io/maintenance/yes/3000)
2020-06-19 09:53:15 +00:00
[![Build status](https://ci.appveyor.com/api/projects/status/32r7s2skrgm9ubva?svg=true&retina=true)](https://ci.appveyor.com/project/JohnTheGr8/flow-launcher/branch/dev)
2020-04-25 07:46:43 +00:00
[![Github All Releases](https://img.shields.io/github/downloads/Flow-Launcher/Flow.Launcher/total.svg)](https://github.com/Flow-Launcher/Flow.Launcher/releases)
![GitHub Release Date](https://img.shields.io/github/release-date/Flow-Launcher/Flow.Launcher)
2021-02-18 21:55:11 +00:00
[![GitHub release (latest by date)](https://img.shields.io/github/v/release/Flow-Launcher/Flow.Launcher)](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest)
2021-02-18 21:46:56 +00:00
[![Documentation](https://img.shields.io/badge/Documentation-7389D8)](https://flow-launcher.github.io/docs)
2020-10-18 02:13:24 +00:00
[![Discord](https://img.shields.io/discord/727828229250875472?color=7389D8&labelColor=6A7EC2&label=Community&logo=discord&logoColor=white)](https://discord.gg/AvgAQgh)
2015-12-15 20:41:41 +00:00
2020-04-26 11:37:22 +00:00
Flow Launcher. Dedicated to make your workflow flow more seamlessly. Aimed at being more than an app launcher, it searches, integrates and expands on functionalities. Flow will continue to evolve, designed to be open and built with the community at heart.
2015-11-03 15:34:59 +00:00
2020-04-27 11:17:18 +00:00
<sub>Remember to star it, flow will love you more :)</sub>
2020-04-25 07:46:43 +00:00
## Features
2021-02-17 11:33:07 +00:00
2020-05-17 14:47:21 +00:00
![The Flow](https://user-images.githubusercontent.com/26427004/82151677-fa9c7100-989f-11ea-9143-81de60aaf07d.gif)
2016-11-11 21:12:55 +00:00
2020-06-08 11:36:00 +00:00
- Search everything from applications, files, bookmarks, YouTube, Twitter and more. All from the comfort of your keyboard without ever touching the mouse.
- Search for file contents.
2021-02-26 12:11:59 +00:00
- Do mathematical calculations and copy the result to clipboard.
2021-02-04 08:56:08 +00:00
- Support search using environment variable paths.
2020-04-25 07:46:43 +00:00
- Run batch and PowerShell commands as Administrator or a different user.
- Support languages from Chinese to Italian and more.
- Support wide range of plugins.
2021-02-04 08:56:08 +00:00
- Prioritise the order of each plugin's results.
- Save file or folder locations for quick access.
2020-04-25 07:46:43 +00:00
- Fully portable.
2016-04-24 15:29:38 +00:00
2021-01-13 08:39:54 +00:00
[<img width="12px" src="https://user-images.githubusercontent.com/26427004/104119722-9033c600-5385-11eb-9d57-4c376862fd36.png"> **SOFTPEDIA EDITOR'S PICK**](https://www.softpedia.com/get/System/Launchers-Shutdown-Tools/Flow-Launcher.shtml)
2021-01-10 09:59:49 +00:00
2020-04-25 07:46:43 +00:00
## Running Flow Launcher
2019-11-07 18:47:54 +00:00
| [Windows 7 and up](https://github.com/Flow-Launcher/Flow.Launcher/releases/latest) |
| ---------------------------------------------------------------------------------- |
2020-04-26 11:37:22 +00:00
Windows may complain about security due to code not being signed, this will be completed at a later stage. If you downloaded from this repo, you are good to continue the set up.
2021-02-18 14:00:06 +00:00
### Integrations
2021-02-18 21:01:54 +00:00
- If you use Python plugins:
- Install [Python3](https://www.python.org/downloads/), download `.exe` installer.
- Add Python to `%PATH%` or set it in flow's settings.
2021-02-11 03:00:17 +00:00
- Use `pip` to install `flowlauncher`, open cmd and type `pip install flowlauncher`.
- The Python plugin may require additional modules to be installed, please ensure you check by visiting the plugin's website via `pm install` + plugin name, go to context menu and select `Open website`.
- Start to launch your Python plugins.
2021-02-26 12:17:32 +00:00
- Flow searches files and contents via Windows Index Search, to use Everything: `pm install everything`.
2016-11-11 11:41:33 +00:00
2021-02-18 14:00:06 +00:00
### Usage
- Open flow's search window: <kbd>Alt</kbd>+<kbd>Space</kbd> is the default hotkey.
2021-02-04 09:01:50 +00:00
- Open context menu: on the selected result, press <kbd>Ctrl</kbd>+<kbd>O</kbd>/<kbd>Shift</kbd>+<kbd>Enter</kbd>.
- Cancel/Return to previous screen: <kbd>Esc</kbd>.
2021-02-18 21:01:54 +00:00
- Install/Uninstall/Update plugins: in the search window, type `pm` `install`/`uninstall`/`update` + the plugin name.
2020-04-25 07:46:43 +00:00
- Saved user settings are located:
- If using roaming: `%APPDATA%\FlowLauncher`
- If using portable, by default: `%localappdata%\FlowLauncher\app-<VersionOfYourFlowLauncher>\UserData`
2021-02-04 09:02:55 +00:00
- Logs are saved along with your user settings folder.
2016-05-18 14:02:29 +00:00
2021-02-18 21:01:54 +00:00
[More tips](https://flow-launcher.github.io/docs/#/usage-tips)
## Plugins
Here are some actively maintained plugins you can install.
| Name | Repo | Function | Woxy Port? |
| --- | --- | --- | --- |
| WoxDictionary | https://github.com/jjw24/WoxDictionary/releases/latest | Dictionary | y |
| Google Search Plus | https://github.com/jjw24/Wox.Plugin.GoogleSearch/releases/latest | Google Search | y |
| SpotifyPremium | https://github.com/jjw24/Wox.Plugin.SpotifyPremium/releases/latest | Spotify Search | y |
| Runner | https://github.com/jjw24/Wox.Plugin.Runner/releases/latest | Create command line aliases | y |
| Clipboard Manager | https://github.com/Xenolphthalein/Flow.Launcher.Plugin.ClipboardHistory | Manage your clipboard
| WindowWalker | https://github.com/taooceros/Microsoft.Plugin.WindowWalker | Alt+Tab Enhancer | Y |
| ipadr | https://github.com/taooceros/Flow.Plugin.IPAddress | Tells you your IP address | Y |
| UrlEncode | https://github.com/taooceros/Flow.Plugin.UrlEncode | Encode/Decode strings for URLs | Y |
| Putty | https://github.com/jjw24/Flow.Launcher.Plugin.Putty | Launch a PuTTy client | Y |
| FancyEmoji | https://github.com/821C3/Wox.Plugin.FancyEmoji | Emoji Search | n |
| IsPrime | https://github.com/lvonkacsoh/wox-plugin-isPrime | Tells you if an entered number is prime or not | n |
| DiskSpace | https://github.com/roose/Wox.Plugin.DiskSpace | Shows available disk space | n |
| wox-dash-velocity | https://github.com/etiago/wox-dash-velocity | Integrate with [Velocity](https://velocity.silverlakesoftware.com/) | n |
| LibreTranslate | https://github.com/taooceros/Flow.LibreTranslate | Multi-language translation tool with [LibreTranslate](https://github.com/uav4geo/LibreTranslate) back-end | y |
There is an [open issue](https://github.com/Flow-Launcher/Flow.Launcher/issues/170) where you can request existing Wox or PowerToys Run plugins be ported. You can also do this yourself using the instructions in [our documentation](https://flow-launcher.github.io/docs/#/port-plugins).
2020-04-26 11:43:52 +00:00
## Status
Flow is under heavy development, but the code base is stable, so contributions are very welcome. If you would like to help maintain it, please do not hesistate to get in touch.
## Contributing
2016-05-18 14:02:29 +00:00
2020-04-25 07:46:43 +00:00
We welcome all contributions. If you are unsure of a change you want to make, simply put an issue in for discussion, otherwise feel free to put in a pull request.
2015-11-03 23:21:27 +00:00
2020-04-25 07:46:43 +00:00
You will find the main goals of flow placed under Projects board, so feel free to contribute on that. If you would like to make small incremental changes, feel free to do so as well.
2020-06-20 05:07:41 +00:00
Get in touch if you like to join the Flow-Launcher Team and help build this great tool.
2021-02-17 11:33:07 +00:00
## Question/Suggestion
2017-03-02 00:27:16 +00:00
2020-04-25 07:46:43 +00:00
Yes please, submit an issue to let us know.
2020-10-18 02:13:24 +00:00
**Join our community on [Discord](https://discord.gg/AvgAQgh)!**
2020-04-26 11:52:44 +00:00
## Developing/Debugging
2021-02-23 10:12:27 +00:00
Flow Launcher's target framework is .Net 5
2017-03-31 10:39:20 +00:00
Install Visual Studio 2019
2019-06-24 15:01:00 +00:00
2021-02-23 10:12:27 +00:00
Install .Net 5 SDK via Visual Studio installer or manually from [here](https://dotnet.microsoft.com/download/dotnet/thank-you/sdk-5.0.103-windows-x64-installer)
2020-04-25 07:46:43 +00:00
2020-04-26 11:43:52 +00:00
## Documentation
2020-04-25 07:46:43 +00:00
2021-02-19 02:49:56 +00:00
Visit [here](https://flow-launcher.github.io/docs) for more information on usage, development and design documentations