bunnypmsl — Smart browser bookmarks with Rust

A modern rust clone of bunny1.

Demo

Enter gh facebook/react in your browser's address bar to open the React repository on GitHub.

Or run the CLI:

$ bunnypmsl gh facebook/react

Installation

Install from crates.io:

# Install both CLI and server (3.9MB)
$ cargo install bunnypmsl

# Install just the CLI (1.4MB - recommended for terminal use only)
$ cargo install bunnypmsl --features cli --no-default-features

# Install just the server (3.6MB - recommended for web server deployments)
$ cargo install bunnypmsl --features server --no-default-features

Or build from source:

# Clone the repository
$ git clone https://github.com/daveio/bunnypmsl.git
$ cd bunnypmsl

# Install both CLI and server
$ cargo install --path .

# Install just the CLI
$ cargo install --path . --features cli --no-default-features

# Install just the server
$ cargo install --path . --features server --no-default-features

CLI Quickstart

Use bunnypmsl to open URLs directly from your terminal!

Basic Usage

# Open GitHub
$ bunnypmsl gh

# Open Instagram Reels
$ bunnypmsl ig reels

# Open a specific GitHub repository
$ bunnypmsl gh facebook/react

# Preview URL without opening browser (dry-run)
$ bunnypmsl --dry-run gh facebook/react
# Output: https://github.com/facebook/react

# List all available commands with a beautiful table
$ bunnypmsl list

Quick Examples

Recommended: Create a Shell Alias

For even faster access, add an alias to your shell configuration:

# Add to ~/.bashrc or ~/.zshrc
alias b="bunnypmsl"

# Then use it like this:
$ b ig reels
$ b gh facebook/react
$ b list

CLI Configuration

The bunnypmsl CLI supports optional configuration via a TOML file following the XDG Base Directory Specification.

Configuration File Location

Bunnypmsl uses different config file locations depending on how it's run:

For CLI and manual server usage (bunnypmsl serve):

• Linux/macOS: ~/.config/bunnypmsl/config.toml (or $XDG_CONFIG_HOME/bunnypmsl/config.toml if set)
• Windows: %APPDATA%\bunnypmsl\config.toml

For system service (sudo bunnypmsl service install):

• Linux: /etc/bunnypmsl/config.toml

The config file is automatically created with sensible defaults when you first run bunnypmsl.

Configuration Features

The CLI works perfectly fine without any configuration file. However, you can customize the following features:

1. Default Browser Selection

Specify which browser to open URLs in:

# ~/.config/bunnypmsl/config.toml
browser = "firefox"  # or "chrome", "chromium", "safari", etc.

If not specified, the system default browser is used.

2. Custom Command Aliases

Create your own personalized shortcuts:

[aliases]
work = "gh mycompany"
blog = "gh username/blog"
dotfiles = "gh username/dotfiles"

Then use them like any built-in command:

$ bunnypmsl work
# Opens: https://github.com/mycompany

$ bunnypmsl blog
# Opens: https://github.com/username/blog

3. Custom Default Search Engine

Override Google as the fallback search engine:

default_search = "ddg"  # Options: "google" (default), "ddg", "bing"

When a command isn't recognized, it will search using your configured engine instead of Google.

4. Command History Tracking

Track your recently used commands (enabled by default):

[history]
enabled = true
max_entries = 1000

History is stored at:

• Linux/macOS: ~/.local/share/bunnypmsl/history (or $XDG_DATA_HOME/bunnypmsl/history if set)
• Windows: %APPDATA%\bunnypmsl\history

Complete Configuration Example

Here's a full example with all available options:

# ~/.config/bunnypmsl/config.toml

# Browser to open URLs in (optional)
browser = "firefox"

# Custom command aliases (optional)
[aliases]
work = "gh mycompany"
blog = "gh username/blog"
dotfiles = "gh username/dotfiles"
notes = "gh username/notes"

# Default search engine when command not recognized (optional)
# Options: "google" (default), "ddg", "bing"
default_search = "ddg"

# Command history settings (optional)
[history]
enabled = true
max_entries = 1000

# Server configuration (for bunnypmsl serve) (optional)
[server]
port = 8000
address = "127.0.0.1"  # Use "0.0.0.0" for network access
log_level = "normal"   # Options: "normal", "debug", "critical", "off"
server_display_url = "https://bunny.example.com"  # Public URL shown on bindings page

Platform-Specific Directory Structure

The CLI uses platform-appropriate directories for configuration and data:

Quickstart - Web Server

After installing bunnypmsl, start the server:

$ bunnypmsl serve

Or use Docker:

$ git clone https://github.com/daveio/bunnypmsl.git
$ cd bunnypmsl
$ docker compose up -d

Or build from source:

$ git clone https://github.com/daveio/bunnypmsl.git
$ cd bunnypmsl
$ cargo run -- serve

Installing as a System Service

For production use on Linux, install bunnypmsl as a systemd service that starts automatically on boot:

# Install bunnypmsl first
$ cargo install bunnypmsl

# Install as system service (requires sudo, Linux only)
# Default: localhost only (127.0.0.1)
$ sudo bunnypmsl service install

# For network access (production servers)
$ sudo bunnypmsl service install --network

# The installer will:
# - Create /etc/systemd/system/bunnypmsl.service
# - Create /etc/bunnypmsl/config.toml with server settings
# - Enable autostart on boot
# - Start the service immediately

# Manage the service
$ sudo bunnypmsl service status
$ sudo bunnypmsl service logs -f
$ sudo bunnypmsl service restart

# Uninstall
$ sudo bunnypmsl service uninstall

Network Access:

• Without --network (default): Binds to 127.0.0.1 (localhost only, secure default)
• With --network: Binds to 0.0.0.0 (accessible from network, for production servers)

The service installer works on:

• Linux: systemd (Ubuntu 16.04+, Debian 8+, CentOS 7+, etc.)

macOS and Windows: Use Docker instead (see above) or run bunnypmsl serve directly.

For more details, see the Deployment Guide.

Open your web browser and navigate to http://localhost:8000/?cmd=fb to get redirected to Facebook.

Open http://localhost:8000/?cmd=gh daveio/bunnypmsl to be redirected to this repo.

Setting bunnypmsl to be your default search engine

You can set your default search engine to http://localhost:8000/?cmd=%s and use bunnypmsl for everything. For this to work, you will need to have the server deployed and running locally or on a server.

Note: For best results, deploy bunnypmsl on a networked server accessible from all your devices, rather than just running it locally.

Desktop Browsers

• Guide for doing this in Desktop Chrome
• Guide for doing this in Desktop Firefox

Mobile Browsers

Note: iOS Safari does not support custom search engines, so you'll need to use Firefox (or another browser that does) instead.

iOS (Firefox)

1. Install Firefox and set it as the default browser
2. Change your default search engine in Firefox for iOS

Android (Firefox)

• Guide for managing default search engines in Firefox for Android

Command Reference

Built With

• Rust
• Rocket - Web framework
• Leptos - Frontend framework for the bindings page
• clap - CLI argument parser
• tabled - Beautiful terminal tables

Getting Started

See the Installation section to install bunnypmsl from crates.io.

To build from source or contribute to the project, see Manual Setup below.

Manual Setup

Make sure you have Rust installed.

$ git clone https://github.com/daveio/bunnypmsl.git
$ cd bunnypmsl

# Run the web server
$ cargo run -- serve

# OR run the CLI (in a separate terminal)
$ cargo run -- gh facebook/react

# OR install globally for easier access
$ cargo install --path .

Deployment with Docker

Bunnypmsl is designed to be easy to deploy anywhere using Docker.

# run on default port 8000
$ docker compose up -d

# run on custom port 9000
$BUNNYPMSL_PORT=9000·docker compose up

The application will be running at http://localhost:8000 by default.

Where to Deploy

Docker makes it easy to deploy anywhere:

• Any cloud provider (AWS, GCP, Azure, DigitalOcean, Hetzner, etc.)
• VPS / home servers

For detailed deployment instructions, reverse proxy setup, and troubleshooting, see the Deployment Guide.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. See CONTRIBUTING for more information.

License

Distributed under the MIT License. See LICENSE for more information.

Acknowledgments

• The Rust Community
• Rocket.rs
• @othneildrew - for the README template