unurgunite / firefox-bookmarks-script

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

firefox-bookmarks-script

What is it and why?

This repository created to simplify my and someone else's life to prevent problem that sometimes Mozilla Firefox cannot restore previous session and you lose all your value bookmarks. So you can manage your bookmarks by yourself, just use bookmrk tool that helps you manage your bookmarks and run them at startup system. I have created three groups: zno-study, prog-study and entertainment, so you can manage your bookmarks something like - zno-study for school bookmarks, prog-study for programming bookmarks, entertainment for your films or something else you waste your free time for. Of course, if you need only one of these group, for example, entertainment - you can use only this group, other groups gonna be ignored if they empty. So, every group of bookmarks is separate Firefox window with your saved bookmarks!

Content

  1. Requirements
  2. Instruction
    1. Installation
    2. Usage
    3. Supported OS
    4. Uninstall
  3. License

Requirements

All what you need is Mozilla Firefox Browser and zsh (maybe bash fits and works fine, but i haven't tested).

Instruction

Installation

Clone repository

git clone https://github.com/KR1470R/firefox-bookmarks-script.git 
cd firefox-bookmarks-script

Install tool by setup.sh

./setup.sh -i

Step 1:

Do you want to install startup launcher of your saved bookmarks to your firefox?[Y/n]

That's gonna install script that will be run auto launch bookmarks at startup system.(Must have)

Step 2:

Do you want to install bookmarks manager?[Y/n]

And that's gonna install the tool for manage your bookmarks whose starts in Step 1. (Must have)

Usage

Bookmrks help page:

$ bookmrk -h
Usage: bookmrk -h | --license or [type bookmark] -a | -r | -c | -l [bookmark]
     -h help                       Show this text
     --license                     Show license page
     type bookmark                 One of the group of bookmarks(i.e prog, ent or zno) 
     -a add bookmark               Add bookmark to the group
     -r remove specific bookmakr   Remove bookmark by specific url from argument
     -c clear all bookmarks        Remove all bookmarks from the list of group
     -l remove last bookmark       Remove last bookmark from the list of group
     bookmark                      URL for some site(i.e www.example.com)

For instance, you wanna add some bookmark to group prog-study that's gonna be starting at every start system:

bookmrk prog -a www.example.com 

You can do it with every group of bookmark.

Here is table of types bookmarks that we put to command:

type to command full name type bookmark
prog prog-study
zno zno-study
ent entertainment
This types created to write your command faster*

Okay, what if you wanna remove bookmarks from specific group? You can remove specific bookmark from specific group(for example prog-study):

bookmrk prog -r www.example.com

You can remove just only last bookmark from specific group:

bookmrk prog -l

Or you can clear fully list bookmarks of specific group:

bookmrk prog -c

That all is okay, but what if you wanna check list bookmarks of specific group?

bookmrk prog -L 

Supported OS

  1. Linux(Arch, Debian, Fedora, etc)
  2. Windows
  3. OS X

Unsupported systems maybe turn to supported soon...

Uninstall

To uninstall bookmrk and startup script, you must go back to our repository with setup.sh and type:

./setup.sh -u

And all files and configs of this tool gonna be removed from your system.

License

MIT License

Copyright (c) 2022 KR1470R

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

License:MIT License


Languages

Language:Shell 100.0%