search-in-terminal 0.1.3

A terminal-based search tool
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

# Command Line Interface Guide

## Basic Usage

```bash
st [OPTIONS] [QUERY]
```

## Options

| Option | Short | Long | Description |
|--------|-------|------|-------------|
| Help | `-h` | `--help` | Display help information |
| Version | `-V` | `--version` | Display version information |
| Engine | `-e` | `--engine` | Specify search engine (google, bing, duckduckgo) |
| Results | `-n` | `--num` | Number of results to display (default: 10) |
| Config | `-c` | `--config` | Path to custom config file |
| Debug | `-d` | `--debug` | Enable debug logging |
| Quiet | `-q` | `--quiet` | Suppress all output except results |

## Examples

1. Basic search:
   ```bash
   st "rust programming"
   ```

2. Search with specific engine:
   ```bash
   st -e google "rust programming"
   ```

3. Specify number of results:
   ```bash
   st -n 20 "rust programming"
   ```

4. Use custom config file:
   ```bash
   st -c ~/myconfig.toml "rust programming"
   ```

5. Debug mode:
   ```bash
   st -d "rust programming"
   ```

6. Combine multiple options:
   ```bash
   st -e bing -n 15 -q "rust programming"
   ```

## Environment Variables

| Variable | Description | Default |
|----------|-------------|---------|
| `ST_CONFIG` | Path to config file | Platform-specific |
| `ST_ENGINE` | Default search engine | google |
| `ST_DEBUG` | Enable debug logging | false |
| `ST_QUIET` | Enable quiet mode | false |

## Exit Codes

| Code | Description |
|------|-------------|
| 0 | Success |
| 1 | General error |
| 2 | Configuration error |
| 3 | Network error |
| 4 | Invalid argument |

## Interactive Commands

While in the TUI:

| Key | Action |
|-----|--------|
| `↑/k` | Move up |
| `↓/j` | Move down |
| `Enter` | Open selected result |
| `q` | Quit |
| `?` | Show help |
| `/` | Search within results |
| `n` | Next search result |
| `N` | Previous search result |
| `o` | Open in browser |
| `y` | Copy URL to clipboard |
| `r` | Refresh results |
| `f` | Toggle full URL display |
| `t` | New tab (if supported) |

## Configuration Integration

The CLI options take precedence over configuration file settings. The precedence order is:

1. Command line arguments
2. Environment variables
3. Configuration file
4. Default values

## Advanced Usage

### Search Operators

- `"exact phrase"`: Search for an exact phrase
- `site:example.com`: Limit search to a specific site
- `-exclude`: Exclude terms from search
- `filetype:pdf`: Search for specific file types

Example:
```bash
st 'site:github.com "rust programming" -beginner filetype:md'
```

### Output Formatting

Use the quiet mode with grep:
```bash
st -q "rust programming" | grep "tutorial"
```

### Multiple Searches

Chain searches with different engines:
```bash
st -e google "rust" && st -e bing "rust"
```

## Troubleshooting

1. If search fails:
   - Check internet connection
   - Verify config file syntax
   - Enable debug mode for detailed logs

2. If results are blocked:
   - Check rate limiting settings
   - Verify user agent configuration
   - Try a different search engine

3. If TUI doesn't display correctly:
   - Check terminal capabilities
   - Verify terminal size
   - Update terminal emulator

## See Also

- [Configuration Guide](CONFIG.md)
- [API Documentation](API.md)
- [Contributing Guide](../CONTRIBUTING.md)