Skip to content

Commit 86a1449

Browse files
authored
Merge pull request #29 from cybrota/docs/fix-readme
feat: simplify README
2 parents eb3ee38 + 8fc1154 commit 86a1449

File tree

1 file changed

+37
-111
lines changed

1 file changed

+37
-111
lines changed

README.md

Lines changed: 37 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,46 @@
11
# Recaller
2+
[![Go](https://img.shields.io/badge/Go-1.18+-blue.svg)](https://golang.org/dl/)
3+
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](#license)
4+
[![Platform](https://img.shields.io/badge/Platform-macOS%20%7C%20Linux-lightgrey.svg)](#supported-platforms)
25

3-
![Recaller Logo](logo.png)
4-
5-
> **Fast, private file & command history search with instant documentation**
6+
<picture width="500">
7+
<source
8+
width="100%"
9+
media="(prefers-color-scheme: dark)"
10+
src="https://github.com/cybrota/recaller/blob/main/recaller-logo.png"
11+
alt="Recaller logo (dark)"
12+
/>
13+
<img
14+
width="100%"
15+
src="https://github.com/cybrota/recaller/blob/main/logo.png"
16+
alt="Recaller logo (light)"
17+
/>
18+
</picture>
619

720
Recaller searches your files and shell history locally with smart ranking, instant help lookup, and terminal integration. All processing happens on your machine - your command history never leaves your computer.
821

9-
[![Go](https://img.shields.io/badge/Go-1.18+-blue.svg)](https://golang.org/dl/)
10-
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](#license)
11-
[![Platform](https://img.shields.io/badge/Platform-macOS%20%7C%20Linux-lightgrey.svg)](#supported-platforms)
22+
Install Recaller easily with this script!
23+
```bash
24+
curl -sf https://raw.githubusercontent.com/cybrota/recaller/refs/heads/main/install.sh | sh
25+
```
1226

13-
## Features
27+
Key Features of Recaller:
1428

15-
### 🔍 Command History Search
16-
- **Smart Search**: Commands ranked by frequency and recency with configurable search modes
17-
- **Fuzzy Search**: Substring matching anywhere in commands (default)
18-
- **Prefix Search**: Fast matching of command beginnings (configurable)
19-
- **Instant Help**: View man pages and command documentation without leaving the interface
20-
- **Terminal Integration**: Copy to clipboard or execute in new terminal tabs
29+
* **Smart Command Search**: Commands ranked by frequency and recency with configurable search modes.
30+
* **Instant Help**: View man pages and command documentation without leaving the interface.
31+
* **Terminal Integration**: Copy to clipboard or execute in new terminal tabs.
32+
* **Multi-Directory Indexing**: Index multiple directories simultaneously for comprehensive file search.
33+
* **Auto Re-indexing**: Automatically discovers new files when launching the search UI.
34+
* **Smart File Ranking**: Files ranked by access frequency and recency.
35+
* **Privacy First**: All processing happens locally - your history stays on your machine.
2136

22-
### 📁 Filesystem Search
23-
- **Multi-Directory Indexing**: Index multiple directories simultaneously for comprehensive file search
24-
- **Auto Re-indexing**: Automatically discovers new files when launching the search UI
25-
- **Smart File Ranking**: Files ranked by access frequency and recency
26-
- **Filter Toggle**: Instantly switch between showing all files, directories only, or files only
27-
- **Fast Search**: Blazing-fast search through indexed files and directories
28-
- **File Operations**: Open files with default applications or copy paths to clipboard
37+
## Why use Recaller?
2938

30-
### 🔒 Privacy & Performance
31-
- **Privacy First**: All processing happens locally - your history stays on your machine
32-
- **Keyboard-Driven**: Full keyboard navigation with intuitive shortcuts
33-
- **Cross-Platform**: Works on macOS and Linux with automatic terminal detection
39+
Tired of forgetting complex commands or searching for files across different directories? Recaller is here to help. It provides a fast, private, and efficient way to search your command history and files. With its smart ranking and instant help features, you can boost your productivity and streamline your workflow. And since all processing happens locally, your data remains private and secure.
3440

35-
## 🚀 Installation
41+
## Getting Started
42+
43+
### Installing Recaller
3644

3745
**Install Script (Recommended)**
3846
```bash
@@ -51,7 +59,7 @@ git clone https://github.com/cybrota/recaller.git
5159
cd recaller && go build -o recaller . && sudo mv recaller /usr/local/bin/
5260
```
5361

54-
## 🔧 Setup
62+
### Configuring Your Project
5563

5664
**Shell Configuration** (Required for Bash users)
5765
- **Bash**: Follow [setup guide](docs/setup-bash.md) to enable timestamped history
@@ -83,7 +91,7 @@ filesystem:
8391
- ".DS_Store"
8492
```
8593
86-
## 💻 Usage
94+
## Usage
8795
8896
### Command History Search
8997
```bash
@@ -109,68 +117,12 @@ recaller fs clean --clear # Clear entire index
109117
recaller fs clean --dry-run # Preview what would be cleaned
110118
```
111119

112-
> **🔄 Auto Re-indexing**: When you launch `recaller fs`, it automatically re-indexes all previously indexed directories to discover new files and folders that were added since the last indexing. This keeps your search results up-to-date without manual intervention.
113-
114120
### Configuration
115121
```bash
116122
recaller settings list # View current configuration settings
117123
recaller version # Check version
118124
```
119125

120-
## 🔍 Search Modes
121-
122-
**Fuzzy Search** (Default)
123-
- Matches commands containing your search query **anywhere**
124-
- More intuitive and finds commands with keywords in any position
125-
- Example: `commit` matches `git commit -m "fix"`, `pre-commit run`, etc.
126-
127-
**Prefix Search** (Configurable)
128-
- Matches commands that **start with** your search query
129-
- Fast and efficient for finding commands by their beginning
130-
- Example: `git` matches `git status`, `git commit`, etc.
131-
132-
## ⌨️ Keyboard Shortcuts
133-
134-
### Command History Search
135-
| Key | Action | Key | Action |
136-
|-----|--------|-----|--------|
137-
| `Enter` | Copy to clipboard | `Ctrl+E` | Execute in terminal |
138-
| `↑/↓` | Navigate | `Tab` | Switch panels |
139-
| `F1` | Show help | `Ctrl+R` | Reset input |
140-
| `Ctrl+U` | Insert command | `Ctrl+Z` | Copy text |
141-
| `Ctrl+J/K` | Jump first/last | `Esc` | Quit |
142-
143-
### Filesystem Search
144-
| Key | Action | Key | Action |
145-
|-----|--------|-----|--------|
146-
| `Enter` | Open file | `Ctrl+X` | Copy path |
147-
| `↑/↓` | Navigate | `Tab` | Switch panels |
148-
| `Ctrl+T` | **Toggle filter** | `Ctrl+R` | Reset input |
149-
| `Ctrl+J/K` | Jump first/last | `Esc` | Quit |
150-
151-
> **New**: `Ctrl+T` cycles through filter modes: **All** (📁📄) → **Directories** (📁) → **Files** (📄)
152-
153-
## 🔒 Privacy & Security
154-
155-
**Your data stays local**: Recaller processes your command history entirely on your machine. No data is sent to external servers or cloud services. Your command history remains private and secure.
156-
157-
## 📋 Requirements
158-
159-
- **OS**: macOS 10.12+ or Linux
160-
- **Clipboard**: Linux users need `xclip` (`sudo apt install xclip`)
161-
- **Terminals**: Auto-detects Terminal.app, iTerm2, GNOME Terminal, Konsole, and others
162-
163-
164-
## 🔄 Shell Support
165-
166-
| Shell | Support | Setup |
167-
|-------|---------|-------|
168-
| **Bash** | ✅ Full | [Required config](docs/setup-bash.md) |
169-
| **Zsh** | ✅ Full | [Optional config](docs/setup-zsh.md) |
170-
| **Fish** | 🔄 Planned | - |
171-
172-
> **⚠️ Bash users**: Requires timestamped history. See [setup guide](docs/setup-bash.md).
173-
174126
## 🤝 Contributing
175127

176128
Contributions welcome! Areas for improvement:
@@ -186,32 +138,6 @@ cd recaller && go mod tidy && go run .
186138

187139
## 📝 License
188140

189-
Licensed under the Apache License, Version 2.0 (the "License");
190-
you may not use this file except in compliance with the License.
191-
You may obtain a copy of the License at
192-
193-
http://www.apache.org/licenses/LICENSE-2.0
194-
195-
Unless required by applicable law or agreed to in writing, software
196-
distributed under the License is distributed on an "AS IS" BASIS,
197-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
198-
See the License for the specific language governing permissions and
199-
limitations under the License.
200-
201-
Copyright © 2025 [Naren Yellavula](https://github.com/narenaryan)
202-
203-
## 🙏 Acknowledgments
204-
205-
- Built with [termui](https://github.com/gizak/termui) for the beautiful terminal interface
206-
- Uses [clipboard](https://github.com/atotto/clipboard) for cross-platform clipboard support
207-
- Inspired by the need for better command-line productivity tools
208-
209-
---
210-
211-
<div align="center">
212-
213-
**Star ⭐ this repository if you find it useful!**
214-
215-
[Report Bug](https://github.com/cybrota/recaller/issues) · [Request Feature](https://github.com/cybrota/recaller/issues) · [Documentation](https://github.com/cybrota/recaller/wiki)
141+
Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE) for details.
216142

217-
</div>
143+
Copyright © 2025 [Naren Yellavula](https://github.com/narenaryan)

0 commit comments

Comments
 (0)