LinuxCommandLibrary

shiori

Bookmark and archive webpages for offline reading

TLDR

Import bookmarks from HTML Netscape bookmark format file

$ shiori import [path/to/bookmarks.html]
copy

Save the specified URL as bookmark
$ shiori add [url]
copy

List the saved bookmarks
$ shiori print
copy

Open the saved bookmark in a browser
$ shiori open [bookmark_id]
copy

Start the web interface for managing bookmarks at port 8181
$ shiori serve --port [8181]
copy

SYNOPSIS

shiori <command> [arguments...] [options...]

PARAMETERS

add <url>
    Adds a new bookmark from the specified URL. Various options allow setting title, tags, and custom notes.

list
    Displays a list of all saved bookmarks. Supports filtering, sorting, and pagination.

search <keyword>
    Searches bookmarks by keyword in titles, URLs, or tags. Supports multiple keywords and specific fields.

update <id>
    Modifies an existing bookmark by its ID. Allows changing title, URL, tags, and other properties.

delete <id>...
    Deletes one or more bookmarks by their IDs. Can also delete all bookmarks at once.

open <id>...
    Opens one or more bookmarks in the default web browser.

tags
    Manages and lists existing tags used for bookmarks. Can be used to rename or delete tags.

serve
    Starts the Shiori web server, making the bookmark manager accessible via a web browser.

import <path>
    Imports bookmarks from a file, commonly supporting Netscape HTML format.

export <path>
    Exports all bookmarks to a file in a specified format (e.g., Netscape HTML).

version
    Prints the current Shiori application version.

--help, -h
    Displays help information for the main command or a specific subcommand.

--port <port>
    Global option: Specifies the port for the web server when using the 'serve' command.

DESCRIPTION

Shiori is an open-source, self-hosted bookmark manager primarily written in Go. It provides a robust command-line interface for managing bookmarks, alongside a sleek web-based user interface. Users can save, organize, tag, and search their web links efficiently. A key feature is its ability to archive web pages, ensuring content remains accessible even if the original source changes or disappears. It's designed for personal use, offering a private and customizable alternative to cloud-based bookmarking services. Shiori is not a standard Linux system utility but rather an application that can be installed and run on Linux.

CAVEATS

Shiori is not a standard Linux command or system utility. It is an independent open-source application that must be installed separately (e.g., by compiling from source or downloading a pre-built binary). Its behavior, available commands, and options might vary based on the installed version. Each subcommand also possesses its own set of specific options (flags) not fully detailed here, which can be viewed using shiori <command> --help.

INSTALLATION

Shiori is not pre-installed on most Linux systems. It can be installed by downloading pre-built binaries from its GitHub releases page, or by compiling it from source using Go. For instance, to install from source: go install github.com/go-shiori/shiori/cmd/shiori@latest
Some Linux distributions or community repositories might offer pre-packaged versions, but these are not universally available.

COMMON USAGE PATTERNS

To add a new bookmark:
shiori add https://example.com --title "Example Site" --tags web,reference

To start the web UI:
shiori serve --port 8080

To list all bookmarks:
shiori list

To search for a bookmark:
shiori search linux

HISTORY

Shiori was created by Raditya I.R. as an open-source project, with its initial public releases and development beginning around late 2018 to early 2019. It emerged as a response to the need for a self-hosted, private, and efficient bookmark management solution, distinct from commercial cloud offerings. Its development primarily utilizes the Go programming language, leveraging its capabilities for creating fast and portable binaries.

Copied to clipboard