kidex-common 0.1.0

Helper library for interacting with Kidex
Documentation
  • Coverage
  • 0%
    0 out of 14 items documented0 out of 3 items with examples
  • Size
  • Source code size: 5.61 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 280.52 kB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 19s Average build duration of successful builds.
  • all releases: 19s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Homepage
  • Kirottu/kidex
    27 5 1
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • Kirottu

Kidex

A simple file indexing service

Installation

On Arch or Arch-based distros the AUR package kidex-git can be installed.

Manual installation

Simply run the following in the projects directory.

cargo install --path .

Configuration

Kidex only has a single config file to be placed in ~/.config/kidex.ron, which uses the following structure:

Config(
  ignored: [], // A list of patterns to be ignored in all directories
  directories: [
    WatchDir(
      path: "/home/kirottu/Documents", // The root folder to be indexed
      recurse: true, // Recursively index and watch all subfolders
      ignored: [], // Ignore patterns specifically for this directory
    ),
  ],
)

Usage

To start the service, simply run kidex and make sure it runs in the background. To get data from the service, the provided kidex-client binary can be used to get JSON output of the index. Alternatively a tool like Anyrun (with the kidex plugin) can be used to search for files using kidex.