No project description provided
Project description
busca
Simple interactive utility to find the closest matches to a reference file in a directory based on the number of lines in the reference file that exist in each compared file.
Table of Contents
- busca
- Table of Contents
- Usage
- Examples
- Find files that most closely match the source
file_5.py
file in a search directory - Find files that most closely match the source
path_to_reference.json
file in a search directory - Change search to scan the current working directory
- Narrow search to only consider
.json
files whose paths include the substring "foo" and that contain fewer than 1,000 lines - Piped input mode to search the output of a command
- Find files that most closely match the source
- Examples
- Installation
Usage
🧑💻️ To see usage documentation, run
busca -h
Output for v2.0.0
Simple utility to find the closest matches to a reference file or piped input based on the number of lines in the reference that exist in each compared file
Usage: busca --ref-file-path <REF_FILE_PATH> [OPTIONS]
<SomeCommand> | busca [OPTIONS]
Options:
-r, --ref-file-path <REF_FILE_PATH> Local or absolute path to the reference comparison file. Overrides any piped input
-s, --search-path <SEARCH_PATH> Directory or file in which to search. Defaults to CWD
-m, --max-lines <MAX_LINES> The number of lines to consider when comparing files. Files with more lines will be skipped [default: 10000]
-i, --include-glob <INCLUDE_GLOB> Globs that qualify a file for comparison
-x, --exclude-glob <EXCLUDE_GLOB> Globs that disqualify a file from comparison
-c, --count <COUNT> Number of results to display [default: 10]
-h, --help Print help
-V, --version Print version
Examples
Find files that most closely match the source file_5.py
file in a search directory
❯ busca --ref-file-path sample_dir_mix/file_5.py --search-path sample_dir_mix
? Select a file to compare:
sample_dir_mix/file_5.py ++++++++++ 100.0%
> sample_dir_mix/file_5v2.py ++++++++++ 97.5%
sample_dir_mix/nested_dir/file_7.py ++++ 42.3%
sample_dir_mix/aldras/aldras_settings.py ++ 24.1%
sample_dir_mix/aldras/aldras_core.py ++ 21.0%
sample_dir_mix/file_3.py + 13.2%
sample_dir_mix/file_1.py + 11.0%
sample_dir_mix/file_2.py + 9.4%
sample_dir_mix/aldras/aldras_execute.py + 7.5%
sample_dir_mix/file_4.py + 6.9%
[↑↓ to move, enter to select, type to filter]
Find files that most closely match the source path_to_reference.json
file in a search directory
busca --ref-file-path path_to_reference.json --search-path path_to_search_dir
Change search to scan the current working directory
busca --ref-file-path path_to_reference.json
Narrow search to only consider .json
files whose paths include the substring "foo" and that contain fewer than 1,000 lines
busca --ref-file-path path_to_reference.json --include-glob '*.json' --include-glob '**foo**' --max-lines 1000
Piped input mode to search the output of a command
# <SomeCommand> | busca [OPTIONS]
echo 'String to find in files.' | busca
MacOS piped input mode
📝 There is an open issue for MacOS in crossterm
, one of busca's dependencies, that does not allow prompt interactivity when using piped input. Therefore, when a non interactive mode is detected, the file matches will be displayed but not interactively.
This can be worked around by adding the following aliases to your shell .bashrc
or .zshrc
file:
# Wrap commands for busca search busca_cmd_output() { eval "$* > /tmp/busca_search.tmp" && busca -r /tmp/busca_search.tmp }
One-liners to add the wrapper function:
Shell | Command |
---|---|
Bash | echo -e 'busca_cmd_output() {\n\teval "$* > /tmp/busca_search.tmp" && busca -r /tmp/busca_search.tmp\n}' >> ~/.bashrc |
Zsh | echo -e 'busca_cmd_output() {\n\teval "$* > /tmp/busca_search.tmp" && busca -r /tmp/busca_search.tmp\n}' >> ~/.zshrc |
Reload your shell for the function to become available:
# busca_cmd_output <SomeCommand>
busca_cmd_output echo 'String to find in files.'
Installation
Mac OS
Homebrew
brew tap noahbaculi/busca
brew install busca
To update, run
brew update
brew upgrade busca
All platforms (Windows, MacOS, Linux)
Compile from source
-
Install Rust using
rustup
. -
Clone this repo.
-
In the root of this repo, run
cargo build --release
-
Add to path. For example, by copying the compiled binary to your local bin directory.
cp target/release/busca $HOME/bin/
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for busca_py-2.0.0-cp39-cp39-macosx_11_0_arm64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d54b368f519decb81b994cc3acfc853f99e1830c855b996eeb82399efeece6cc |
|
MD5 | 4e195c131b5e01853c1a97dd4b96e0da |
|
BLAKE2b-256 | 889ff33dd6c025ecbc9b98cad25a32a273d2fd27d08c21b97f0a6033bcec557c |