mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-12-23 21:01:58 +00:00

History

Carlo Sala 43613d7b71 fix(web-search): use pattern instead of regex Closes #12202		2024-02-07 11:16:36 +01:00
..
README.md	feat(web-search): add programming packages search (#12199 )	2024-02-06 11:26:30 +01:00
web-search.plugin.zsh	fix(web-search): use pattern instead of regex	2024-02-07 11:16:36 +01:00

README.md

web-search plugin

This plugin adds aliases for searching with Google, Wiki, Bing, YouTube and other popular services.

Open your ~/.zshrc file and enable the web-search plugin:

plugins=( ... web-search)

Usage

You can use the web-search plugin in these two forms:

web_search <context> <term> [more terms if you want]
<context> <term> [more terms if you want]

For example, these two are equivalent:

$ web_search google oh-my-zsh
$ google oh-my-zsh

Available search contexts are:

Context	URL
`bing`	`https://www.bing.com/search?q=`
`google`	`https://www.google.com/search?q=`
`brs` or `brave`	`https://search.brave.com/search?q=`
`yahoo`	`https://search.yahoo.com/search?p=`
`ddg` or `duckduckgo`	`https://www.duckduckgo.com/?q=`
`sp` or `startpage`	`https://www.startpage.com/do/search?q=`
`yandex`	`https://yandex.ru/yandsearch?text=`
`github`	`https://github.com/search?q=`
`baidu`	`https://www.baidu.com/s?wd=`
`ecosia`	`https://www.ecosia.org/search?q=`
`goodreads`	`https://www.goodreads.com/search?q=`
`qwant`	`https://www.qwant.com/?q=`
`givero`	`https://www.givero.com/search?q=`
`stackoverflow`	`https://stackoverflow.com/search?q=`
`wolframalpha`	`https://wolframalpha.com/input?i=`
`archive`	`https://web.archive.org/web/*/`
`scholar`	`https://scholar.google.com/scholar?q=`
`ask`	`https://www.ask.com/web?q=`
`youtube`	`https://www.youtube.com/results?search_query=`
`deepl`	`https://www.deepl.com/translator#auto/auto/`
`dockerhub`	`https://hub.docker.com/search?q=`
`npmpkg`	`https://www.npmjs.com/search?q=`
`packagist`	`https://packagist.org/?query=`
`gopkg`	`https://pkg.go.dev/search?m=package&q=`

Also there are aliases for bang-searching DuckDuckGo:

Context	Bang
`wiki`	`!w`
`news`	`!n`
`map`	`!m`
`image`	`!i`
`ducky`	`!`

Custom search engines

If you want to add other search contexts to the plugin, you can use the $ZSH_WEB_SEARCH_ENGINES variable. Set it before Oh My Zsh is sourced, with the following format:

ZSH_WEB_SEARCH_ENGINES=(
    <context> <URL>
    <context> <URL>
)

where <context> is the name of the search context, and <URL> a URL of the same type as the search contexts above. For example, to add reddit, you'd do:

ZSH_WEB_SEARCH_ENGINES=(reddit "https://www.reddit.com/search/?q=")

These custom search engines will also be turned to aliases, so you can both do web_search reddit <query> or reddit <query>.