Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sreedevk/bkmrq
Export Your Bookmarks to Web Formats
https://github.com/sreedevk/bkmrq
bkmrq bookmarks-export bookmarks-renderer markdown ruby
Last synced: about 2 months ago
JSON representation
Export Your Bookmarks to Web Formats
- Host: GitHub
- URL: https://github.com/sreedevk/bkmrq
- Owner: sreedevk
- License: mit
- Archived: true
- Created: 2021-11-01T16:19:39.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-04T22:36:45.000Z (about 1 year ago)
- Last Synced: 2024-09-01T04:48:48.038Z (5 months ago)
- Topics: bkmrq, bookmarks-export, bookmarks-renderer, markdown, ruby
- Language: Ruby
- Homepage:
- Size: 69.4 MB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# bkmrq
bkmrq `(pronounced bookmark)` is a command-line tool for organizing and transferring bookmarks across multiple browsers including Chrome, Firefox, Safari, and Opera. With just a few simple commands, export bookmarks in JSON, Markdown, CSV, and HTML formats. Ideal for automated scripts and command line users, it's fast and efficient. Specify format and location to easily transfer bookmarks, perfect for backups and sharing.
# Disclaimer
This project is still under development. If you would like to contribute, please checkout [CONTRIBUTING.md]().
Bkmrq Currently only supports the following browsers
- Brave (Default Profile Only)
- Chromium (Default Profile Only)
- Chrome (Default Profile Only)
The following formats are supported for exporting bookmarks
- markdown
- json
- html
# Installation
Running Bkmrq requires ruby installed (>= 3.0.0)
```bash
gem install bkmrq
```
# Usage
```
___ __
/ _ )/ /__ __ _ _______ _
/ _ / '_// ' \/ __/ _ `/
/____/_/\_\/_/_/_/_/ \_, /
/_/
# Examples
--------------------------------
# Export Bookmarks from Brave Browser in Markdown format
$ bkmrq export --to=brave_bookmarks.md --browser=brave --format=markdown
# Export Bookmarks from Chromium Browser
# in Markdown format & exclude bookmarks/folders with the word "php" and "java"
$ bkmrq export --to=chromium_books.md --browser=chromium --format=markdown --exclude="php,java"
--------------------------------
# Supported Browsers(--browser=)
- brave
- chromium
- chrome
- firefox
- opera
- safari (mac only)
# Supported Export Formats (--format=)
- markdown
- json
- html
- csv
# OPTIONS:
-o, --to=FILEPATH save the export file to
-b, --browser=BROWSER export bookmarks from
-f, --format=FILEFORMAT export bookmarks to File.
-x, --exclude=XPATTERNS exclude bookmarks or folders containing
-v, --version Print Version
-h, --help Print help docs
```
# Examples
An example markdown file generated using this gemfile is available [here](https://github.com/sreedevk/bookmarks/blob/main/README.md)
Export bookmarks from `Brave Browser` in `markdown` format to `brave_bookmarks.md` file
```bash
$ bkmrq -b brave -f markdown -o brave_bookmarks.md
```
Export bookmarks from `Brave Browser` in `json` format to `brave_bookmarks.json` file
```bash
$ bkmrq -b brave -f json -o brave_bookmarks.json
```