generall / shiori

Simple bookmark manager built with Go

Shiori

Shiori is a simple bookmarks manager written in Go language. Intended as a simple clone of Pocket. You can use it as command line application or as web application. This application is distributed as a single binary, which means it can be installed and used easily.

Table of Contents

• Features
• Installation
• Usage
• Examples
• License

Features

• Simple and clean command line interface.
• Basic bookmarks management i.e. add, edit and delete.
• Search bookmarks by their title, tags, url and page content.
• Import and export bookmarks from and to Netscape Bookmark file.
• Portable, thanks to its single binary format and sqlite3 database
• Simple web interface for those who don't want to use a command line app.
• Where possible, by default shiori will download a static copy of the webpage in simple text and HTML format, which later can be used as an offline archive for that page.

Installation

You can download the latest version of shiori from the release page, then put it in your PATH. If you want to build from source, make sure go is installed, then run :

go get github.com/RadhiFadlillah/shiori

Usage

Simple command-line bookmark manager built with Go.

Usage:
  shiori [command]

Available Commands:
  account     Manage account for accessing web interface
  add         Bookmark the specified URL
  delete      Delete the saved bookmarks
  export      Export bookmarks into HTML file in Netscape Bookmark format
  help        Help about any command
  import      Import bookmarks from HTML file in Netscape Bookmark format
  open        Open the saved bookmarks
  print       Print the saved bookmarks
  search      Search bookmarks by submitted keyword
  serve       Serve web app for managing bookmarks
  update      Update the saved bookmarks

Flags:
  -h, --help   help for shiori

Use "shiori [command] --help" for more information about a command.

Examples

1. Save new bookmark with tags "nature" and "climate-change".

   shiori add https://grist.org/article/let-it-go-the-arctic-will-never-be-frozen-again/ -t nature,climate-change
   

2. Print all saved bookmarks.

   shiori print
   

3. Print bookmarks with index 1 and 2.

   shiori print 1 2
   

4. Search bookmarks that contains "sqlite" in their title, excerpt, url or content.

   shiori search sqlite
   

5. Search bookmarks with tag "nature".

   shiori search -t nature
   

6. Delete all bookmarks.

   shiori delete
   

7. Delete all bookmarks with tag "nature".

   shiori delete $(shiori search -t nature -i)
   

8. Update all bookmarks' data and content.

   shiori update
   

9. Update bookmark in index 1.

   shiori update 1
   

10. Change title and excerpt from bookmark in index 1.

    shiori update 1 -i "New Title" -e "New excerpt"
    

11. Add tag "future" and remove tag "climate-change" from bookmark in index 1.

    shiori update 1 -t future,-climate-change
    

12. Import bookmarks from HTML Netscape Bookmark file.

    shiori import exported-from-firefox.html
    

13. Export saved bookmarks to HTML Netscape Bookmark file.

    shiori export target.html
    

14. Open all saved bookmarks in browser.

    shiori open
    

15. Open text cache of bookmark in index 1.

    shiori open 1 -c
    

16. Serve web app in port 9000.

    shiori serve -p 9000
    

17. Create new account for login to web app.

    shiori account add username
    

License

Shiori is distributed using MIT license, which means you can use and modify it however you want. However, if you make an enhancement for it, if possible, please send a pull request.