dashy/docs/searching.md

Keyboard Shortcuts

Searching

One of the primary purposes of Dashy is to allow you to quickly find and launch a given app. To make this as quick as possible, there is no need to touch the mouse, or press a certain key to begin searching - just start typing. Results will be filtered in real-time. No need to worry about case, special characters or small typos, these are taken care of, and your results should appear.

Navigating

You can navigate through your items or search results using the keyboard. You can use Tab to cycle through results, and Shift + Tab to go backwards. Or use the arrow keys, ↑, →, ↓ and ←.

Launching Apps

You can launch a elected app by hitting Enter. This will open the app using your default opening method, specified in target (either newtab, sametab, modal or workspace). You can also use Alt + Enter to open the app in a pop-up modal, or Ctrl + Enter to open it in a new tab. For all available opening methods, just right-click on an item, to bring up the context menu.

Tags

By default, items are filtered by the title attribute, as well as the hostname (extracted from url), the provider and description. If you need to find results based on text which isn't included in these attributes, then you can add tags to a given item.

  items:
  - title: Plex
    description: Media library
    icon: favicon
    url: https://plex.lab.local
    tags: [ movies, videos, music ]
  - title: FreshRSS
    description: RSS Reader
    icon: favicon
    url: https://freshrss.lab.local
    tags: [ news, updates, blogs ]

In the above example, Plex will be visible when searching for 'movies', and FreshRSS with 'news'

Custom Hotkeys

For apps that you use regularly, you can set a custom keybinding. Use the hotkey parameter on a certain item to specify a numeric key, between 0 - 9. You can then launch that app, by just pressing that key, which is much quicker than searching for it, if it's an app you use frequently.

- title: Bookstack
  icon: far fa-books
  url: https://bookstack.lab.local/
  hotkey: 2
- title: Git Tea
  icon: fab fa-git
  url: https://git.lab.local/
  target: workspace
  hotkey: 3

In the above example, pressing 2 will launch Bookstack. Or hitting 3 will open Git in the workspace view.

Web Search

It's possible to search the web directly from Dashy, which might be useful if you're using Dashy as your start page. This can be done by pressing ⏎ after typing your query into the search bar. Web search options are configured under appConfig.webSearch.

Setting Search Engine

By default, DuckDuckGo is used as the search engine, but you can change this by setting webSearch.searchEngine to the key of your favorite search provider. Currently supported providers:

• Main: duckduckgo, google, whoogle, qwant, startpage, searx-bar, searx-info
• Nice: searx-tiekoetter, searx-bissisoft, ecosia, metager, swisscows, mojeek, peekier
• Specific: wikipedia, wolframalpha, stackoverflow, github, reddit, youtube, bbc

Using Custom Search Engine

If you're self-hosting your own search engine (like Whoogle or Searx) or you'd like to use a provider not included in this list, then just set searchEngine: custom and put the URL of your engine, along with the GET parameter for query string, into customSearchEngine

Setting Opening Method

By default, results are opened in a new tab, but sametab, newtab and workspace are all supported

Disabling Web Search

Web search can be disabled, by setting disableWebSearch: true

appConfig:
  theme: dashy-docs
  webSearch:
    disableWebSearch: false
    searchEngine: 'duckduckgo'
    customSearchEngine: ''
    openingMethod: 'newtab'

Clearing Search

You can clear your search term at any time, by pressing Esc. This can also be used to close an open pop-up modal.