Skip to content

Latest commit

 

History

History
45 lines (28 loc) · 1.36 KB

README.md

File metadata and controls

45 lines (28 loc) · 1.36 KB
Raw

marks

A simple and fast search-engine like tool for org/markdown files. WIP.

Installation

Right now you need to either clone the repository and build it yourself or install it from crates.io using cargo.

crates.io

Install cargo through your package manager. Then:

cargo install marks

This will install marks binary under ~/.cargo/bin.

Cloning and installing

git clone https://github.com/isamert/marks.git
cd marks
cargo install --path .

This will install marks binary under ~/.cargo/bin.

Usage

marks is pretty intuitive, it's similar to Google. Observe the following query:

marks --path . --query 'marks can "search" `(org|markdown)` files -folders'

This query requires

  • the word search to be either in the title hierarchy or in the line.
  • regex (org|markdown) to match either in the title hierarchy or in the line.
  • the word folders not to be present in the title hierarchy or the line itself.

Rest of the characters are matched in fuzzy fashion. Output is similar to how grep outputs the results with only difference being title hierarchy is also added to results: filename:line-no:title/hierarchy/here:matched-line-contents. This command will search for all the markdown and org-mode files under given path. This is configurable.

You can always do marks --help to get more detailed information.