Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/solidiquis/fsac
⚡ fast fuzzy search terminal application that queries what you're looking for and provides the result to a custom command.
https://github.com/solidiquis/fsac
concurrent-programming fuzzy-search go golang terminal-app
Last synced: 6 days ago
JSON representation
⚡ fast fuzzy search terminal application that queries what you're looking for and provides the result to a custom command.
- Host: GitHub
- URL: https://github.com/solidiquis/fsac
- Owner: solidiquis
- License: mit
- Created: 2021-04-12T02:02:44.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-04-12T05:45:19.000Z (over 3 years ago)
- Last Synced: 2024-06-20T09:12:38.720Z (5 months ago)
- Topics: concurrent-programming, fuzzy-search, go, golang, terminal-app
- Language: Go
- Homepage:
- Size: 36.1 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# fsac
Lightning fast scrollable (**f**)uzzy (**s**)earch utility for the terminal, the result of which can be easily provided as an (**a**)rgument to a custom (**c**)ommand - comes with tab autocomplete! This repo is intended to contain a collection of applications that make use of **fsac**, so contributing is highly encouraged :]
## How to install an fsac program
Make sure you have Go installed.
**Option 1**:
`git clone` this repo and from the project's root directory:
```
$ make compile_dirsearch dest=path/to/my/bin_name
```
Make sure that the executable is in your `$PATH`.
**Option 2**:
Make sure you `$GOPATH` is set, then run:
```
$ go get github.com/solidiquis/fsac/cmd/dirf
```
## Wish to contribute by making an fsac program?
Again, this repo will contain a collection of programs which can be compiled independently. Here are the steps to follow if you wish to contribute:
1. Make a new directory in `cmd/` named after your program.
2. Make your program and give it a short catchy name, kind of like `grep`, which is short for `global regular expression print`.
3. Add something like this to the top of your `main.go`:
```
// Installation:
// go get github.com/solidiquis/fsac/cmd/dirf
// Name:
// dirf -> (dir)ectory (f)ind
// Utility:
// Searches through directory tree from working directory and
// copies selection to clipboard.
```
4. Add three new targets to the `Makefile`, using `dirf` as a template: `run`, `debug`, & `compile`.
5. Make a pull request :]
## Libraries used
- https://github.com/sahilm/fuzzy: Awesome string matching algorithm.
- https://github.com/solidiquis/ansigo: Convenient Go-wrapper for various ANSI escapes + keypress detection.
## License
MIT