https://github.com/mattrichmo/BookMarker

Simple CLI to add a bookmark to markdown and html file from anywhere in your terminal. Creates bookmarks.md & bookmarks.html
https://github.com/mattrichmo/BookMarker

bookmarks cli cli-app command command-line internet markdown markdown-to-html python-3 simple terminal terminal-based useful-utilities

Last synced: 3 months ago
JSON representation

Simple CLI to add a bookmark to markdown and html file from anywhere in your terminal. Creates bookmarks.md & bookmarks.html

• Host: GitHub
• URL: https://github.com/mattrichmo/BookMarker
• Owner: mattrichmo
• Created: 2023-09-06T18:09:36.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-10T04:53:53.000Z (about 1 year ago)
• Last Synced: 2024-06-17T13:16:16.692Z (5 months ago)
• Topics: bookmarks, cli, cli-app, command, command-line, internet, markdown, markdown-to-html, python-3, simple, terminal, terminal-based, useful-utilities
• Language: Python
• Homepage:
• Size: 24.4 KB
• Stars: 8
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# BookMarker

Simple CLI to add a bookmark from anywhere in your terminal. 

## Useage

install: 

```

./install.sh

```

then after installation is complete, you can use the following examples, from anywhere in your terminal to add a bookmark to your documents folder. 

```

bookmark http://example.com 

```

or

```

bk http://example.com 

```

Additional optional args can be passed: 

```

bk http://example.com -d "This is a description" -f "This is a Folder Name" -t " tag1, tag2, tag3"

```

Creates a md file and bookmarks.html that looks like this: 

bookmarks.md:

```

- Example Folder

	- [This is an example](https://linktest.com) - Tags: tag1, tag2, tag4

	- [This is an example](https://linktest.com) - Tags: tag1, tag2, tag4

```

bookmarks.html:

```

Bookmarks

Bookmarks



Example Folder





This is an example



This is an example







```

## Additional Args

Create Subfolders (passed with link)

```

bk -f "folder/subfolder/subfolder of a subfolder/etc"

```

List all "Folders":

```

bk --folders

```

List all Links: 

```

bk --list --all

```

List All Links Within A "Folder":

```

bk --list --f "Folder/Subfolder/etc"

```

List All By Tag

```

bk --list --t "Tag"

```

Export to bookmarks.html

```

bk --export

```

Import Existing bookmarks.html from browser

```

bk --import "path/to/your/bookmarks.html"

```

## TO-DO

- ~~Folder Heirachies ~~

- ~~List All Within A Folder~~

- ~~List All By Tag~~

- add date added field so it doesnt interfere with the html file

- add syntax handling so mispelled words dont auto get added to link list