How to use the command 'shiori' (with examples)

Shiori is a simple and efficient bookmark manager built with the Go programming language. It allows users to organize, store, and manage their bookmarks from the command line or through a web interface. Whether you’re transitioning from another bookmark manager or simply want a more streamlined way to handle your online resources, Shiori provides a variety of functionalities to fit your needs.

Use case 1: Import bookmarks from HTML Netscape bookmark format file

Code:

shiori import path/to/bookmarks.html

Motivation:

Importing bookmarks from an HTML Netscape bookmark format file is crucial for users transitioning from a different browsing setup or a bookmark managing application that exports with this standard format. It allows for a seamless transition without manually adding each bookmark, saving time and effort.

Explanation:

• shiori: This is the command to execute the Shiori application.
• import: This subcommand tells Shiori to start the import process.
• path/to/bookmarks.html: This is the file path to your existing bookmarks in Netscape HTML format. The path should lead to where this file is stored on your system.

Example Output:

Successfully imported 120 bookmarks from bookmarks.html

This output indicates that Shiori was able to process and import all the bookmarks from the specified file successfully.

Use case 2: Save the specified URL as bookmark

Code:

shiori add url

Motivation:

Saving a URL using Shiori allows users to quickly bookmark a webpage directly from the command line. This is particularly useful for users who prefer keyboard-centric workflows and want to avoid context-switching between the terminal and a browser.

Explanation:

• shiori: Executes the Shiori application.
• add: A subcommand used to add a new bookmark.
• url: Placeholder for the actual URL you want to save. Replace it with the web address you wish to bookmark.

Example Output:

Bookmark added: Example URL - https://example.com

The output confirms that the given URL has been successfully added to the list of bookmarks within Shiori.

Use case 3: List the saved bookmarks

Code:

shiori print

Motivation:

Listing all saved bookmarks is beneficial for quickly viewing what has been stored without the need to open a browser. This can help users manage their bookmarks more effectively, identifying entries to edit, delete, or prioritize.

Explanation:

• shiori: Executes the Shiori application.
• print: A subcommand to list all saved bookmarks in Shiori’s storage.

Example Output:

1. Example URL - https://example.com
2. Another Site - https://anothersite.com
3. New Resource - https://newresource.com

This output provides a list of all bookmarks currently managed by Shiori, showing both the title and URL for each entry.

Use case 4: Open the saved bookmark in a browser

Code:

shiori open bookmark_id

Motivation:

Opening a bookmark directly in a browser saves time and seamlessly integrates with your workflow. Rather than manually searching for a bookmark, users can quickly open the desired page through a simple command.

Explanation:

• shiori: Executes the Shiori application.
• open: This subcommand indicates the intention to open a bookmark.
• bookmark_id: Refers to the unique identifier of the bookmark you want to open. This ID can be found using the shiori print command.

Example Output:

Opening bookmark: Example URL - https://example.com in default browser.

This response indicates that Shiori has successfully opened the specified bookmark in your default web browser.

Use case 5: Start the web interface for managing bookmarks at port 8181

Code:

shiori serve --port 8181

Motivation:

Launching a web interface to manage bookmarks can offer a more user-friendly environment for users who prefer graphical interfaces. This web interface allows for more efficient management of bookmarks with added features like search and categorization, accessible from any device with a web browser on the same network.

Explanation:

• shiori: Executes the Shiori application.
• serve: This command initializes the web interface.
• --port 8181: Specifies the network port on which the web interface will be available. The port number can be changed as needed.

Example Output:

Starting web server at http://localhost:8181

This output indicates that the Shiori web interface is successfully running and can be accessed through a web browser at the specified address and port.

Conclusion:

Shiori proves to be a powerful tool for managing bookmarks efficiently, offering both command-line and graphical interface methods tailored to different user preferences. Whether you’re importing from existing bookmark files or managing bookmarks with ease through a web interface, Shiori integrates seamless functionality into bookmark management.