Skip to content

README.md

Latest commit

 

History

History
111 lines (77 loc) · 3.36 KB

README.md

File metadata and controls

111 lines (77 loc) · 3.36 KB
Raw

Mexboard

Mexboard UI in dark mode Mexboard UI in light mode Gifs from KLIPY in Mexboard UI

Mexboard is a Clipboard Manager app built with Tauri for creators and developers. It works on Linux and Windows.

Motivation

Many clipboard managers I used on Linux don't have features that I need i.e keyboard shortcuts, emojis and symbols selection, sync clipboard across device, and they don't have nice UI.

Mexboard is fast, have most features that I need, and have nice UI.

Quick Start

Download the latest version from Releases and install.

📖 Usage

Linux

Run mexboard show or mexboard show --tab=clipboards to show clipboard list.

You can add the command to your system keymap.

Example:

  • Super + v: mexboard show --tab=clipboards. Then you can open Mexboard window using Super + v.

Details for Pop OS 24.04: Navigate to Settings > Input devices > Keyboard > Keyboard shortcuts > Custom, then click Add shortcut:

  • Shortcut name: Mexboard (or whatever you like)
  • Command: mexboard show --tab=clipboards
  • Shortcut: Super + v (make sure there's no conflict)

Windows

Run C:\Users\[YOUR_USERNAME]\AppData\Local\Mexboard\mexboard.exe show or C:\Users\[YOUR_USERNAME]\AppData\Local\Mexboard\mexboard.exe show --tab=clipboards in your Terminal or PowerShell to show clipboard list.

You can add the command to your system keymap. You can use PowerToys.

Example:

  • Win + Alt + V: C:\Users\sokhuong\AppData\Local\Mexboard\mexboard.exe show

or

  • Win + Alt + V: C:\Users\sokhuong\AppData\Local\Mexboard\mexboard.exe show --tab=clipboards

Details for PowerToys:

  • Action: Run Program
  • App: C:\Users\[YOUR_USERNAME]\AppData\Local\Mexboard\mexboard.exe
  • Args: show --tab=clipboards
  • Start in: C:\Users\sokhuong\AppData\Local\Mexboard
  • Elevation: Normal
  • If running: Start another (Mexboard will handle single instance so don't need to worry whether multiple app will be opened)
  • Visibility: Normal

🤝 Contributing

Clone the repo

git clone https://github.com/skuong/mexboard.git
cd mexboard

Development

Requirements:

Set up environment variables

cp .env.example .env

VITE_BETTER_AUTH_BASE_URL=http://localhost:8787 and VITE_WEBSOCKET_BASE_URL=ws://localhost:8787 are for cloud sync.

Don't worry about it for getting the app to work.

Install dependencies

pnpm i

Run in development mode

pnpm tauri dev

Run the test suite

cd src-tauri
cargo test

Build for production

pnpm tauri build

Submit a pull request

If you'd like to contribute, please fork the repository and open a pull request to the beta branch.