Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/baioc/busk

Plain text search using an inverted trigram index

https://github.com/baioc/busk

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (10.7%) to scientific vocabulary

Keywords

grep search-engine
Last synced: 5 months ago · JSON representation

Repository

Plain text search using an inverted trigram index

Basic Info
  • Host: GitHub
  • Owner: baioc
  • License: agpl-3.0
  • Language: C
  • Default Branch: master
  • Homepage:
  • Size: 53.7 KB
Statistics
  • Stars: 0
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
grep search-engine
Created 7 months ago · Last pushed 6 months ago
Metadata Files
Readme License

README.md

busk

Plain text search using an inverted trigram index.

Usage

Combined example: shell $ busk.mk-index src/ | busk.search "stbds_" src/mk-index.c src/index.c src/search.c

busk.mk-index: ```shell Generate a text search index from the given files and/or directories.

Usage: busk.mk-index [-v] [-o OUTPUT] ... -o, --output=OUTPUT Output index to OUTPUT instead of stdout -v, --verbose Print more verbose output to stderr -?, --help Give this help list --usage Give a short usage message -V, --version Print program version ```

busk.search: ```shell Query an index, listing files to grep a search string in.

Usage: busk.search [-v] [-i INPUT] "" -i, --index=INPUT Read index from INPUT instead of stdin -v, --verbose Print more verbose output to stderr -?, --help Give this help list --usage Give a short usage message -V, --version Print program version ```

Installation

Dependencies

Tested on Ubuntu 24.04 (Noble Numbat): - glibc - Installed by default - stb - sudo apt install libstb-dev

Building from source

  • Make sure you have installed the dependencies listed above
  • You'll also need make, gcc and pkg-config for the build
  • Grab a copy of the source code
  • make clean build RELEASE=1
  • make test (optional)
  • make install (installs to ~/.local/bin by default, make sure that's in your $PATH)
    • Undo with make uninstall

License

Copyright (C) 2025-present Gabriel B. Sant'Anna

This software is dual-licensed: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License version 3 or, in case you wish to use it under different terms, you can get in touch with the copyright holders in order to negotiate a commercial license.

Owner

  • Name: Gabriel B. Sant'Anna
  • Login: baioc
  • Kind: user
  • Location: Earth, Solar System, Local Interstellar Cloud, Local Bubble, Orion-Cygnus Galactic Arm, Milky Way
  • Company: BRy Tecnologia

"Don't let school get in the way of your education." - Mark Twain

GitHub Events

Total
  • Push event: 3
Last Year
  • Push event: 3