shiori README

The project's README from github.com/go-shiori/shiori. As one markdown file: README.md.

Shiori

IC Go Report Card #shiori-general:matrix.org Containers

Check out our latest Announcements

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

Screenshot

Features

Comparison of reader mode and archive mode

Documentation

All documentation is available in the docs folder. If you think there is incomplete or incorrect information, feel free to edit it by submitting a pull request.

License

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

shiori (go-shiori/shiori)

archive
Searching Database…

11.7K ·GitHub
What is this?Shiori is a simple bookmark manager written in Go, built as a clone of Pocket. It saves, organizes and archives web pages so you keep access to them even if the original page disappears.
Is it a CLI tool or a web app?Both: Shiori ships as a single binary that works as a command line application and also runs a web interface for managing bookmarks without the terminal.
How do I get it running?Download the single compiled binary and run it; there's no separate installer or dependency setup needed to start using it.
Which databases does it support?Shiori works with SQLite3 out of the box, and also supports PostgreSQL, MariaDB and MySQL if you want a different backend.
Is browser extension support ready to use?The Firefox and Chrome web extension integration is still marked BETA, so expect rough edges compared to the core CLI/web app.
Does it keep an offline copy of pages, not just a link?Yes — by default Shiori parses the readable content of a page and creates an offline archive of it, so bookmarks survive even if the original site goes down or changes.
Can I bring in bookmarks from Pocket or my browser?Shiori can import bookmarks from Pocket and from standard Netscape Bookmark files, and can also export your bookmarks back out in that same format.
What basic bookmark operations does it support?You can add, edit, delete and search bookmarks through either the CLI or the web interface.
What are similar projects?usql, migrate, cachet, dolt, linkwarden, Termix, redash, onedump
Creator
go-shiori
Size
49 MB
Stars
11.7K
Age
8y
Commits · 90 Days