Welcome to flogin’s documentation!¶
A wrapper for Flow Lancher’s V2 jsonrpc api using python, to easily and quickly make Flow launcher plugins.
Features:
Modern Pythonic API using
asyncandawait.Fully Typed
Easy to use with an object oriented design
Getting started¶
Is this your first time using the library? This is the place to get started!
First steps: Introduction | Quickstart
Examples: Many examples are available in the repository.
Getting help¶
If you’re having trouble with something, these resources might help.
Try the Frequently Asked Questions
Ask us in Flow’s Official Discord Server.
If you’re looking for something specific, try the index or searching.
Report bugs in the issue tracker.
First Steps
References
- API Reference
- Version Related Info
- Types
- Plugins
PluginPlugin.event()Plugin.search()Plugin.apiPlugin.check_for_log_override_files()Plugin.fetch_flow_settings()Plugin.flow_application_dirPlugin.flow_program_dirPlugin.flow_versionPlugin.last_queryPlugin.metadataPlugin.register_event()Plugin.register_search_handler()Plugin.register_search_handlers()Plugin.run()Plugin.settingsPlugin.start()
- Models
- JSON RPC
- Results
ResultResult.titleResult.subResult.iconResult.title_highlight_dataResult.title_tooltipResult.sub_tooltipResult.copy_textResult.pluginResult.previewResult.progress_barResult.auto_complete_textResult.rounded_iconResult.glyphResult.callback()Result.context_menu()Result.create_with_partial()Result.from_dict()Result.on_context_menu_error()Result.on_error()Result.to_dict()
ResultPreviewProgressBarGlyphResultConstructorKwargs
- Responses
- Results
- Search Handlers
- Flow
- API
FlowLauncherAPIFlowLauncherAPI.add_keyword()FlowLauncherAPI.change_query()FlowLauncherAPI.check_for_updates()FlowLauncherAPI.fuzzy_search()FlowLauncherAPI.get_all_plugins()FlowLauncherAPI.hide_main_window()FlowLauncherAPI.is_main_window_visible()FlowLauncherAPI.open_directory()FlowLauncherAPI.open_settings_menu()FlowLauncherAPI.open_url()FlowLauncherAPI.reload_all_plugin_data()FlowLauncherAPI.remove_keyword()FlowLauncherAPI.restart_flow_launcher()FlowLauncherAPI.run_shell_cmd()FlowLauncherAPI.save_all_app_settings()FlowLauncherAPI.save_plugin_settings()FlowLauncherAPI.show_error_message()FlowLauncherAPI.show_main_window()FlowLauncherAPI.show_notification()FlowLauncherAPI.update_results()
FuzzySearchResultPluginMetadataPluginMetadata.idPluginMetadata.namePluginMetadata.authorPluginMetadata.versionPluginMetadata.languagePluginMetadata.descriptionPluginMetadata.websitePluginMetadata.disabledPluginMetadata.directoryPluginMetadata.keywordsPluginMetadata.main_keywordPluginMetadata.add_keyword()PluginMetadata.executablePluginMetadata.iconPluginMetadata.remove_keyword()
- Settings
FlowSettingsFlowSettings.hotkeyFlowSettings.open_result_modifiersFlowSettings.color_schemeFlowSettings.show_open_result_gotkeyFlowSettings.window_sizeFlowSettings.preview_hotkeyFlowSettings.autocomplete_hotkeyFlowSettings.autocomplete_hotkey_2FlowSettings.select_next_item_hotkeyFlowSettings.select_next_item_hotkey_2FlowSettings.select_previous_item_hotkeyFlowSettings.select_previous_item_hotkey_2FlowSettings.select_next_page_hotkeyFlowSettings.select_previous_page_hotkeyFlowSettings.open_context_menu_hotkeyFlowSettings.setting_window_hotkeyFlowSettings.cycle_history_up_hotkeyFlowSettings.cycle_history_down_hotkeyFlowSettings.languageFlowSettings.themeFlowSettings.use_drop_shadow_effectFlowSettings.window_height_sizeFlowSettings.item_height_sizeFlowSettings.query_box_font_sizeFlowSettings.result_item_font_sizeFlowSettings.result_sub_item_font_sizeFlowSettings.query_box_fontFlowSettings.query_box_font_styleFlowSettings.query_box_font_weightFlowSettings.query_box_font_stretchFlowSettings.result_fontFlowSettings.result_font_styleFlowSettings.result_font_weightFlowSettings.result_font_stretchFlowSettings.result_sub_fontFlowSettings.result_sub_font_styleFlowSettings.result_sub_font_weightFlowSettings.result_sub_font_stretchFlowSettings.use_glyph_iconsFlowSettings.use_animationFlowSettings.use_soundFlowSettings.sound_volumeFlowSettings.use_clockFlowSettings.use_dateFlowSettings.time_formatFlowSettings.date_formatFlowSettings.first_launchFlowSettings.setting_window_widthFlowSettings.setting_window_heightFlowSettings.setting_window_topFlowSettings.setting_window_leftFlowSettings.setting_window_stateFlowSettings.custom_explorer_indexFlowSettings.custom_explorer_listFlowSettings.custom_browser_indexFlowSettings.custom_browser_listFlowSettings.should_use_pinyinFlowSettings.always_previewFlowSettings.always_start_enFlowSettings.query_search_precisionFlowSettings.auto_updatesFlowSettings.window_leftFlowSettings.window_topFlowSettings.custom_window_leftFlowSettings.custom_window_topFlowSettings.keep_max_resultsFlowSettings.max_results_to_showFlowSettings.activate_timesFlowSettings.custom_plugin_hotkeysFlowSettings.custom_shortcutsFlowSettings.dont_prompt_update_msgFlowSettings.enable_update_logFlowSettings.start_flow_launcher_on_system_startupFlowSettings.hide_on_startupFlowSettings.hide_notify_iconFlowSettings.leave_cmd_openFlowSettings.hide_when_deactivatedFlowSettings.search_window_screenFlowSettings.search_window_alignFlowSettings.custom_screen_numberFlowSettings.ignore_hotkeys_on_fullscreenFlowSettings.proxyFlowSettings.last_query_modeFlowSettings.animation_speedFlowSettings.custom_animation_lengthFlowSettings.plugin_settings
CustomQueryShortcutCustomFileManagerCustomBrowserCustomPluginHotkeyHttpProxyPartialPluginPluginsSettingsLastQueryModeSearchWindowScreensSearchWindowAlignsAnimationSpeedsSearchPrecisionScore
- API
- Errors
- Testing
- Utils
- Pip
- Caching
- Event Reference