shiori

command module
v0.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 9, 2019 License: MIT Imports: 8 Imported by: 0

README

Shiori

Build Status Go Report Card GoDoc GitHub release FOSSA Status

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.

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.

Demo

A demo can be found at: https://shiori-demo.techknowlogick.com/ where the user/password are both demo. The database will be wiped every so often, so please don't use this for anything other than quick evaluation.

FAQs

Why did you make this fork?

My goals for this fork were to change things for my personal preferences.

What are the changes made to this repo?

Please see the list of changes made to this project compared to the original.

Is there any contact between the two repos?

Yes, I've let Radhi know about my changes and we will work on trying to get them back into the original project. Due to some changes I made make it harder to create PRs to merge things back into the original.

Is the original Shiori not being updated anymore?

There was a brief hiatus, however Radhi plans on updating the original project again. There have already been improvments made to the go-readability project by Radhi. Please see the answer to this question provided by Radhi for more details.

Are the two projects compatible?

Switching between the two projects is currently possible by replacing your existing binary, however DB schema changes may eventually be made that require a DB migration.

Should I use this fork instead of the original?

Please support the original project, however if you prefer to use this fork that is OK too.

License

Shiori is distributed using MIT license, which means you can use and modify it however you want. However, if you make an enhancement, if possible, please send a pull request to the original project. If you make a bugfix, please send a pull request to both projects.

FOSSA Status

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL