Back to Flow Launcher

README

README.md

2.1.122.7 KB
Original Source
<p align="center"> <a href="https://flowlauncher.com">
    </a>

    
</p> <p align="center">

<a href="https://crowdin.com/project/flow-launcher"></a> <a href="https://ci.appveyor.com/project/JohnTheGr8/flow-launcher/branch/dev"></a> <a href="https://github.com/Flow-Launcher/Flow.Launcher/releases"></a>

<a href="https://github.com/Flow-Launcher/Flow.Launcher/releases/latest"></a> <a href="https://flowlauncher.com/docs"></a> <a href="https://discord.gg/AvgAQgh"></a>

</p> <p align="center"> A quick file search and app launcher for Windows with community-made plugins.</p> <p align="center"> Dedicated to making your workflow more seamless. Search everything from applications, files, bookmarks, YouTube, Twitter and more. Flow will continue to evolve, designed to be open and built with the community at heart.</p> <p align="center"> <sub>Remember to star it, Flow will love you more :)</sub></p> <h4 align="center"> <a href="#-getting-started">Getting Started</a> • <a href="#-features">Features</a> • <a href="#-plugins">Plugins</a> • <a href="#%EF%B8%8F-hotkeys">Hotkeys</a> • <a href="#sponsors">Sponsors</a> • <a href="#-questionssuggestions">Questions/Suggestions</a> • <a href="#development">Development</a> • <a href="https://flowlauncher.com/docs">Docs</a> </h4>

🚗 Getting Started

Installation

Windows 10+ Installer or Portable Version

Winget

winget install "Flow Launcher"

Scoop

scoop install Flow-Launcher

Chocolatey

choco install Flow-Launcher

When installing for the first time Windows may raise an issue about security due to code not being signed, if you downloaded from this repo then you are good to continue the set up.

Or download the early access version.

🎁 Features

Applications & Files

  • Search for apps, files or file contents.

  • Supports Everything and Windows Index.

  • Supports search using environment variable paths.

Web Searches & URLs

Browser Bookmarks

System Commands

Calculator

  • Do mathematical calculations and copy the result to clipboard.

Shell Command

  • Run batch and PowerShell commands as Administrator or a different user.
  • <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Enter</kbd> to Run as Administrator.

Explorer

  • Save file or folder locations for quick access.

Windows & Control Panel Settings

  • Search for Windows & Control Panel settings.

Dialog Jump

  • Search for a file/folder and quickly jump to its path in the Open/Save As dialog window.
  • Use <kbd>Alt</kbd>+<kbd>G</kbd> to quickly jump the Open/Save As dialog window path to the path of the active file manager.

Drag & Drop

  • Drag a file/folder to File Explorer, or even Discord.
  • Copy/move behavior can be changed via <kbd>Ctrl</kbd> or <kbd>Shift</kbd>, and the operation is displayed on the mouse cursor.

Priority

  • Prioritize the order of each plugin's results.

Preview Panel

  • Use <kbd>F1</kbd> to toggle the preview panel.
  • Media files will be displayed as large images, otherwise a large icon and full path will be displayed.
  • Turn on preview permanently via Settings (Always Preview).
  • Use <kbd>Ctrl</kbd>+<kbd>+</kbd>/<kbd>-</kbd> and <kbd>Ctrl</kbd>+<kbd>[</kbd>/<kbd>]</kbd> to adjust search window width and height quickly if the preview area is too narrow.

Customizations

  • Window size adjustment, animation, and sound

  • Color Scheme (aka Dark Mode)

  • There are various themes and you also can make your own.

Date & Time Display In Search Window

  • Display date and time in search window.

💬 Languages

  • Supports languages from Chinese to Italian and more.
  • Supports Pinyin (拼音) search.
  • Crowdin support for language translations.
<details> <summary>Supported languages</summary> <ul> <li>English</li> <li>中文</li> <li>中文(繁体)</li> <li>Українська</li> <li>Русский</li> <li>Français</li> <li>日本語</li> <li>Dutch</li> <li>Polski</li> <li>Dansk</li> <li>de, Deutsch</li> <li>ko, 한국어</li> <li>Srpski</li> <li>Српски</li> <li>Português</li> <li>Português (Brasil)</li> <li>Spanish</li> <li>es-419, Spanish (Latin America)</li> <li>Italiano</li> <li>Norsk Bokmål</li> <li>Slovenčina</li> <li>Türkçe</li> <li>čeština</li> <li>اللغة العربية</li> <li>Tiếng Việt</li> <li>עברית</li> </ul> </details>

Portable

  • Fully portable.
  • Type flow user data to open your saved user settings folder. They are located at:
    • If using roaming: %APPDATA%\FlowLauncher
    • If using portable, by default: %localappdata%\FlowLauncher\app-<VersionOfYourFlowLauncher>\UserData
    • Type open log location to open your logs folder, they are saved along with your user settings folder.

🎮 Game Mode

  • Pause hotkey activation when you are playing games.
  • When in search window use <kbd>Ctrl</kbd>+<kbd>F12</kbd> to toggle on/off.
  • Type Toggle Game Mode

📦 Plugins

  • Support wide range of plugins. Visit here for our plugin portfolio.
  • Publish your own plugin to Flow! Create plugins in:
<p align="center"> <a href="https://flowlauncher.com/docs/#/develop-dotnet-plugins"></a> <a href="https://github.com/Flow-Launcher/plugin-samples/tree/master/HelloWorldFSharp"></a> <a href="https://www.flowlauncher.com/docs/#/py-develop-plugins"></a> <a href="https://flowlauncher.com/docs/#/nodejs-develop-plugins"></a> <a href="https://flowlauncher.com/docs/#/nodejs-develop-plugins"></a> </p>

SpotifyPremium

Clipboard+

Home Assistant Commander

Colors

GitHub

Window Walker

......and more!

🛒 Plugin Store

  • You can view the full plugin list or quickly install a plugin via the Plugin Store menu inside Settings

  • or type pm install/uninstall/update + the plugin name in the search window,

⌨️ Hotkeys

HotkeyDescription
<kbd>Alt</kbd>+<kbd>Space</kbd>Open search window (default and configurable)
<kbd>Enter</kbd>Execute
<kbd>Ctrl</kbd>+<kbd>Enter</kbd>Open containing folder
<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Enter</kbd>Run as admin
<kbd></kbd>/<kbd></kbd>, <kbd>Shift</kbd>+<kbd>Tab</kbd>/<kbd>Tab</kbd>Previous / Next result
<kbd></kbd>/<kbd></kbd>Back to result / Open Context Menu
<kbd>Ctrl</kbd>+<kbd>O</kbd> , <kbd>Shift</kbd>+<kbd>Enter</kbd>Open Context Menu
<kbd>Ctrl</kbd>+<kbd>Tab</kbd>Autocomplete
<kbd>F1</kbd>Toggle Preview Panel (default and configurable)
<kbd>Esc</kbd>Back to results / hide search window
<kbd>Ctrl</kbd>+<kbd>C</kbd>Copy folder / file
<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>C</kbd>Copy folder / file path
<kbd>Ctrl</kbd>+<kbd>I</kbd>Open Flow's settings
<kbd>Ctrl</kbd>+<kbd>R</kbd>Run the current query again (refresh results)
<kbd>F5</kbd>Reload all plugin data
<kbd>Ctrl</kbd>+<kbd>F12</kbd>Toggle Game Mode when in search window
<kbd>Ctrl</kbd>+<kbd>+</kbd>,<kbd>-</kbd>Adjust maximum results shown
<kbd>Ctrl</kbd>+<kbd>[</kbd>,<kbd>]</kbd>Adjust search window width
<kbd>Ctrl</kbd>+<kbd>H</kbd>Open search history
<kbd>Ctrl</kbd>+<kbd>Backspace</kbd>Back to previous directory
<kbd>PageUp</kbd>/<kbd>PageDown</kbd>Previous / Next Page

System Command List

CommandDescription
ShutdownShutdown computer
RestartRestart computer
Restart With Advanced Boot OptionsRestart the computer with Advanced Boot option for safe and debugging modes
Log Off/Sign OutLog off
LockLock computer
SleepPut computer to sleep
HibernateHibernate computer
Empty Recycle BinEmpty recycle bin
Open Recycle BinOpen recycle bin
ExitClose Flow Launcher
Save SettingsSave all Flow Launcher settings
Restart Flow LauncherRestart Flow Launcher
SettingsTweak this app
Reload Plugin DataRefreshes plugin data with new content
Check For UpdateCheck for new Flow Launcher update
Open Log LocationOpen Flow Launcher's log location
Index OptionOpen Windows Search Index window
Flow Launcher TipsVisit Flow Launcher's documentation for more help and usage tips
Flow Launcher UserData FolderOpen the location where Flow Launcher's settings are stored
Toggle Game ModeToggle Game Mode
Set Flow Launcher ThemeSet the Flow Launcher Theme

💁‍♂️ Tips

Sponsors

<p align="center"> <a href="https://coderabbit.ai/"> </a> <a href="https://github.com/TheBestPessimist"> </a> <a href="https://github.com/Calapine"> </a> </p> <p align="center"> <a href="https://appwrite.io"> </a> </p> <p align="center"> <a href="https://github.com/itsonlyfrans"></a> <a href="https://github.com/atilford"></a> <a href="https://github.com/andreqramos"></a> <a href="https://github.com/benello"></a> <a href="https://github.com/Yuba4"></a> <a href="https://github.com/Mavrik327"></a> <a href="https://github.com/tikkatek"></a> <a href="https://github.com/patrickdobler"></a> <a href="https://github.com/benflap"></a> </p>

Mentions

❔ Questions/Suggestions

Yes please, let us know in the Q&A section. Join our community on Discord!

Development

Localization

Our project localization is based on Crowdin. If you would like to change them, please go to https://crowdin.com/project/flow-launcher.

WPF UI Library

Our UI library is using iNKORE.UI.WPF.Modern.

<a href="https://docs.inkore.net/ui-wpf-modern/introduction"> </a>

New Changes

All changes to Flow are captured via pull requests. Some new changes may have been merged but are still pending release. This means that while a change may not exist in the current release, it may have been accepted and merged into the dev branch and is available as a pre-release download. It is therefore a good idea to search through the open and closed pull requests before you start to make changes to ensure the change you intend to make is not already done.

Each of the pull requests will be marked with a milestone indicating the planned release version for the change.

Contributing

Contributions are very welcome, in addition to the main project (C#) there are also documentation (md), website (html/css) and others that can be contributed to. If you are unsure of a change you want to make, let us know in the Discussions, otherwise feel free to submit a pull request.

You will find the main goals of Flow placed under the 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.

Get in touch if you would like to join the Flow-Launcher Team and help build this great tool.

Developing/Debugging

  • Flow Launcher's target framework is .Net 9

  • Install Visual Studio 2022 (v17.12+)

  • Install .Net 9 SDK

    • via Visual Studio installer
    • via winget winget install Microsoft.DotNet.SDK.9
    • Manually from here