Skip to content

Latest commit

 

History

History
139 lines (96 loc) · 3.34 KB

README.md

File metadata and controls

139 lines (96 loc) · 3.34 KB
Raw

Search in Terminal 🔍

English | 简体中文 | 日本語

Crates.io Downloads License

Table of Contents

A powerful terminal-based search tool that allows you to search and browse web content directly in your terminal. Supports multiple search engines (Google, Bing, DuckDuckGo) with an elegant TUI interface and convenient keyboard controls.

🎯 Why Search in Terminal?

  • Efficiency: Search without leaving your terminal
  • Privacy: Control your user agent and search behavior
  • Customization: Configure search engines and behavior to your needs
  • Speed: Fast and lightweight, with caching support
  • Cross-platform: Works on Linux, macOS, and Windows

Features ✨

  • Multiple Search Engines Support 🌐
    • Google
    • Bing
    • DuckDuckGo
  • Quick Engine Switching 🔄
  • Search Results Caching 💾
  • Beautiful TUI Interface 🎨
  • Convenient Keyboard Controls ⌨️
  • One-click Browser Opening 🚀

Screenshots 📸

Coming soon

Installation 📦

Via Cargo

cargo install search-in-terminal

From Source

git clone https://github.com/zykowal/search-in-terminal.git
cd search-in-terminal
cargo install --path .

Usage 🛠️

After installation, simply run:

st

Keyboard Shortcuts ⌨️

  • i: Input mode
  • <C-u>: Clear input
  • Esc: Exit input mode
  • Enter: Execute search when in input mode
  • e: Switch search engine
  • ↑/↓: Browse search results
  • k/j: Browse search results
  • Enter: Open selected result in browser
  • q: Quit program

Configuration ⚙️

Configuration file location:

  • Linux/macOS: ~/.config/st/config.toml
  • Windows: %APPDATA%\st\config.toml

For detailed configuration options, please see:

Development 👨‍💻

Requirements

  • Rust 2021 edition

Build

git clone https://github.com/zykowal/search-in-terminal.git
cd search-in-terminal
cargo build --release

FAQ 💭

How do I add a custom search engine?

Edit your config file and add a new entry under the [search.engines] section. See the Configuration Guide for details.

How do I change the default search engine?

Set the default_engine option in your config file. See the Configuration Guide for details.

Does it work with proxies?

Sorry! Temporarily unsupported. Use system-level proxy settings.

Contributing 🤝

We welcome contributions! Please see our Contributing Guide for details.

License 📝

MIT License

Author 👤

zykowal

Changelog 📋

See CHANGELOG.md for release details.