seekr-util 0.3.1

System search util for linux
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

<div align="center">
    
# seekr

_System search util for linux_

![seekr-demo](./assets/seekr-demo.gif)

</div>

## Installation

```sh
cargo install seekr-util
```

### Features

- `gtk-layer-shell` allow the seekr window to be displayed as a layer of the
  desktop _[wlr-layer-shell-unstable-v1](https://wayland.app/protocols/wlr-layer-shell-unstable-v1)_
- `file-indexer`, built-in blazing fast file search powered by [Tantivy](https://github.com/quickwit-oss/tantivy).
  Configurable to include/exclude specific directories.
- `Lua plugins`, extend the functionality of seekr by adding custom search
  engines and tools using the Lua programming language.

### Requirements

- [Rust](https://www.rust-lang.org/tools/install)
- [gtk4](https://www.gtk.org/docs/installations/)
- [gtk4-layer-shell](https://github.com/wmww/gtk4-layer-shell) (for gtk-layer-shell support)

## Usage

Running seekr is as simple as

```sh
$ seekr
```

`seekr` can also be run silently by passing the `--silent` options.
This will run seekr without open a window.

To stop the running instance:

```sh
$ seekr --stop
```

## Configuration

On the first run of the app, configurations files will be generated into
`$XDG_CONFIG_HOME/seekr` or `$HOME/.config/seekr`

## Plugins

`seekr` supports Lua plugins to extend its functionality. Plugins are loaded from
the `plugins` directory in your configuration folder (e.g., `~/.config/seekr/plugins`).

A plugin is a Lua script that returns a table containing metadata and event handlers:

```lua
return {
    name = "my_plugin",
    api_version = 1,
    description = "A simple example plugin",
    triggers = { "command=/test" },
    onInput = function(term)
        seekr:log("my_plugin", "User typed: " .. term)
    end,
}
```

Available event handlers: `onInput`, `onEnter`, `onActivate`, `onStartup`, `onExit`.

The `seekr` global object provides several methods for plugins:

- `seekr:show_info_box(plugin_name, title, body)`
- `seekr:show_image_grid(plugin_name, images, subtitle)`
- `seekr:show_console(plugin_name, command)`
- `seekr:exec(command)`
- `seekr:read(command)`

## Contributing

You can contribute to the project in several ways:

- Translating the app via the [./locales/app.yml](./locales/app.yml) file
- Adding new functionalities to improve the tool
- Suggesting new widgets for plugins to use