S

https://github.com/zquestz/s
Admin
S is a command-line utility that allows users to perform web searches directly from the terminal and...
Tokens:3,290
Snippets:10
Trust Score:9.3
License:MIT
Update:1 year ago
Show doc for...
Tokens:
Raw
### Installation: s via Go, Homebrew, AUR

Source: https://github.com/zquestz/s/blob/master/README.md

Provides instructions for installing the 's' command-line tool using Go's package management, Homebrew for macOS, and the Arch User Repository (AUR) for Arch Linux.

```go
go install github.com/zquestz/s@latest
```

```shell
brew install s-search
```

```shell
yay -S s
```

--------------------------------

### Autocompletion Setup: s Command for Shells

Source: https://github.com/zquestz/s/blob/master/README.md

Guides users on setting up command-line autocompletion for 's' in Bash (Linux/macOS), Zsh, Fish, and PowerShell environments.

```bash
# Bash Linux
sudo bash -c "s --completion bash > /etc/bash_completion.d/s"
```

```bash
# Bash MacOS
sudo bash -c "s --completion bash > /usr/local/etc/bash_completion.d/s"
```

```zsh
# Zsh
sudo zsh -c "s --completion zsh > /usr/local/share/zsh/site-functions/_s"
```

```fish
# Fish
s --completion fish > ~/.config/fish/completions/s.fish
```

```powershell
# Powershell
(& s --completion powershell) | Out-String | Invoke-Expression
```

--------------------------------

### Basic Search Examples: s Command

Source: https://github.com/zquestz/s/blob/master/README.md

Demonstrates fundamental usage of the 's' command for searching various providers like presearch, google, amazon, and wikipedia with simple queries.

```shell
# Search for puppies on presearch
s puppies

# Search for dragonflies on google
s -p google dragonflies

# Search for a wifi router on amazon
s -p amazon wifi router

# Search for rhinos on wikipedia
s -p wikipedia rhinos
```

--------------------------------

### Server Mode: s Command with TLS

Source: https://github.com/zquestz/s/blob/master/README.md

Explains how to launch 's' in server mode to provide a web interface, including options for specifying ports and configuring TLS certificates for secure connections.

```shell
# Start a server on the default port 8080
s -s

# Start a server with TLS on port 8443
s -s -c /path/to/cert.pem -k /path/to/key.pem --port 8443
```

--------------------------------

### Configuration: s Command UCL Format

Source: https://github.com/zquestz/s/blob/master/README.md

Details the configuration options for 's' using UCL format, including setting default providers, whitelisting/blacklisting providers, and defining custom providers with URL schemes and tags.

```ucl
# Set default provider to duckduckgo
provider: duckduckgo

# Only search specific providers
whitelist: [google, amazon, wikipedia]

# Exclude specific providers
blacklist: [dumpert]

# Add a custom provider
customProviders [
  {
    name: example
    url: "https://example.com?q=%s"
    tags: [example]
  }
]

# Configuration keys supported:
# blacklist, binary, cert, customProviders, key, output, port, provider, tag, verbose, whitelist
```

--------------------------------

### Provider/Tag Expansion: s Command

Source: https://github.com/zquestz/s/blob/master/README.md

Illustrates how 's' supports partial matching for provider and tag names, allowing for abbreviated searches on platforms like Facebook, Amazon, and tech-news sites.

```shell
# Partial provider match for Facebook
s -p fa hamsters

# Partial provider match for Amazon
s -p am toasters

# Partial tag match for 'tech-news'
s -t te ssd

# Partial tag match for 'shopping'
s -t sh blankets
```

--------------------------------

### Advanced Usage: s Command Aliases and Custom Binary

Source: https://github.com/zquestz/s/blob/master/README.md

Shows advanced configurations for 's', including creating shell aliases for frequent searches and specifying custom binaries for launching search URIs.

```shell
# Setup aliases for Amazon and Wikipedia
alias sa="s -p amazon"
alias sw="s -p wikipedia"

# Use w3m to find cats
s -b w3m cats

# Search in incognito mode with Chromium
s -b "chromium --incognito" conspiracy theories

# Search in private mode with Firefox
s -b "firefox --private-window" conspiracy theories

# Search in a specific subreddit
s -p reddit /r/cscareerquestions best startups
```

--------------------------------

### CLI Usage: s Command Flags

Source: https://github.com/zquestz/s/blob/master/README.md

Details the command-line interface for the 's' tool, outlining available flags for search queries, provider selection, output modes, server configuration, and help.

```text
Usage:
  s <query> [flags]

Flags:
  -b, --binary string       binary to launch search URI
  -c, --cert string         path to cert.pem for TLS
      --completion string   completion script for bash, zsh, fish or powershell
  -h, --help                help for s
  -k, --key string          path to key.pem for TLS
  -l, --list-providers      list supported providers
      --list-tags           list available tags
  -o, --output              output only mode
      --port int            server port (default 8080)
  -p, --provider string     search provider (default "presearch")
  -s, --server              launch web server
  -t, --tag string          search tag
  -v, --verbose             verbose mode
      --version             display version
```

--------------------------------

### Adding a Provider

Source: https://github.com/zquestz/s/blob/master/CONTRIBUTING.md

Steps required when adding a new provider to the S project. This includes commit strategy, documentation updates, and file modifications.

```markdown
1. Each provider should be a **single** commit.
2. Add it to the README.md.
3. Add it to `s.go`.
4. Make sure providers in README.md and s.go are sorted alphabetically.
5. Create a PR.
```

```go
// Add provider to s.go
// Ensure alphabetical order with existing providers
```

```markdown
// Add provider to README.md
// Ensure alphabetical order with existing providers
```

```git
git commit -m "feat: Add new provider X"
```

```shell
gofmt -w .
```

--------------------------------

### Refactoring Guidelines

Source: https://github.com/zquestz/s/blob/master/CONTRIBUTING.md

Process for making refactors to the base code of the S project. Emphasizes prior discussion before submitting a Pull Request.

```markdown
When doing refactors to the base code, make sure to discuss it in an issue prior to PR.
```
Tokens:
Raw