#file #service #indexing #index #helper #config-file #kidex

kidex-common

Helper library for interacting with Kidex

1 unstable release

0.1.0 May 11, 2023

#1244 in Filesystem

Download history 916/week @ 2024-11-17 833/week @ 2024-11-24 817/week @ 2024-12-01 821/week @ 2024-12-08 704/week @ 2024-12-15 710/week @ 2024-12-22 707/week @ 2024-12-29 674/week @ 2025-01-05 671/week @ 2025-01-12 762/week @ 2025-01-19 794/week @ 2025-01-26 795/week @ 2025-02-02 1087/week @ 2025-02-09 1048/week @ 2025-02-16 1097/week @ 2025-02-23 985/week @ 2025-03-02

4,372 downloads per month

GPL-3.0 license

6KB
95 lines

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.

Dependencies

~0.3–1MB
~23K SLoC