https://github.com/nate-wilkins/bookit

Fast and simple bookmark manager for your operating system.
https://github.com/nate-wilkins/bookit

Last synced: 6 days ago
JSON representation

Fast and simple bookmark manager for your operating system.

• Host: GitHub
• URL: https://github.com/nate-wilkins/bookit
• Owner: Nate-Wilkins
• License: lgpl-3.0
• Created: 2022-12-31T06:49:17.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-03-12T01:31:33.000Z (10 months ago)
• Last Synced: 2024-12-24T22:16:09.594Z (20 days ago)
• Language: Rust
• Homepage:
• Size: 85.9 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Bookit

[![Version](https://img.shields.io/crates/v/bookit?style=flat-square)](https://crates.io/crates/bookit)

[![Build](https://img.shields.io/travis/Nate-Wilkins/bookit/main?style=flat-square)](https://app.travis-ci.com/github/Nate-Wilkins/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.

### 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.