bookit 2.1.0

Fast and simple bookmark manager for your operating system.
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
90
91
92
93
94
95
96


[//]: # "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"
[//]: # "!!!!!!                                     !!!!!!"
[//]: # "!!!!!!        >>>>> WARNING <<<<<          !!!!!!"
[//]: # "!!!!!!                                     !!!!!!"
[//]: # "!!!!!!     This file is autogenerated.     !!!!!!"
[//]: # "!!!!!!                                     !!!!!!"
[//]: # "!!!!!!        >>>>> WARNING <<<<<          !!!!!!"
[//]: # "!!!!!!                                     !!!!!!"
[//]: # "!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!"

# bookit

[![Version](https://img.shields.io/crates/v/bookit?style=flat-square)](https://crates.io/crates/bookit)
[![Downloads](https://img.shields.io/crates/d/bookit?color=%230E0&style=flat-square)](https://crates.io/crates/bookit)
[![Open Issues](https://img.shields.io/github/issues-raw/Nate-Wilkins/bookit?style=flat-square)](https://github.com/Nate-Wilkins/bookit/issues)
[![License](https://img.shields.io/github/license/Nate-Wilkins/bookit?color=%2308F&style=flat-square)](https://github.com/Nate-Wilkins/bookit/blob/main/LICENSE)

> Fast and simple bookmark manager for your operating system.

## Install

```
cargo install bookit
```

## Configuration

### Bookmarks

To setup `bookit` you need to run:

```
bookit config create
```

This will create a configuration file for where your bookmarks will be stored.

### Usage

```bash
nix run github:nate-wilkins/bookit -- --help
```

<p align="center">
  <img src="./examples/demo.gif" />
</p>

### Shell Completions

You can put this in your `.zshrc` file (just make sure `$HOME/.zsh_functions/` is in your
`fpath`):

```
if [[ ! -f "$HOME/.zsh_functions/_bookit" ]]; then
  bookit completions --type zsh > "$HOME/.zsh_functions/_bookit"
fi
```

Or you can generate yours with:

```
bookit completions --type $SHELL               # Where $SHELL is zsh,bash,fish,elvish,powershell
```

### Environment Variables

To configure bookit you can update the following variables.

- `$BOOKIT_LOG_LEVEL` (unset): Sets the log level for the program.

- `$BOOKIT_CONFIG_PATH` (`~/.bookit`):
  Configuration file path where bookit stores bookmarks.

- `$BOOKIT_EDIT_COMMAND` (`$EDITOR "$BOOKIT_CONFIG_PATH" "+/$VIM_BOOKIT_BOOKMARK_NAME"`):
  Process command to run to edit a bookmark. Available variables are:
  - `$BOOKIT_CONFIG_PATH`: Path to the configuration.
  - `$BOOKIT_BOOKMARK_NAME`: Name of the bookmark to edit.
  - `$VIM_BOOKIT_BOOKMARK_NAME`: `$BOOKIT_BOOKMARK_NAME` with proper escaping for searching in vim.

## Development

Written in rust. Workflows are defined in `.envrc.sh`.

## Roadmap

- Support `bookit view | grep` piping?
- Create `rofi-bookit`.
- Support windows?
- Create Windows like spotlight.

## Contributions

| Author  | Estimated Hours |
| ------------- | ------------- |
| [![nate-wilkins](https://github.com/nate-wilkins.png?size=64)](https://github.com/nate-wilkins) | <p align="right">11.72 Hours</p> |