Quickstart

This guide will walk you through the steps to get Gosuki up and running on Linux. Windows and macOS support are planned for future releases.

Requirements

Packaged Released

• No extra dependency required

Building from source

• Go: Version 1.20 or later. Install Go
• SQLite: Ensure SQLite library is installed on your system.
• Git: Required if installing from source or using the Go package.

Installation

Install using Go

go install github.com/blob42/gosuki@latest

This will install the gosuki binary in your $GOPATH/bin directory. Make sure this directory is in your $PATH.

Build from source

1. Clone the repository:

   git clone [repository URL]
   cd [repository directory]

2. Build the binary:

   make

3. (optional) if you want the desktop systray feature

   make SYSTRAY=true

4. Move the binaries to your PATH:

   sudo mv bin/gosuki /usr/local/bin/
   sudo mv bin/suki /usr/local/bin/

Arch Linux package

TODO

Running Gosuki

Starting the server

By default the gosuki starts in daemon mode ready to run as a systemd service:

gosuki start 

Starting the server in TUI mode

To start the daemon in TUI mode (for debugging or real-time overview ), execute:

gosuki --tui start

Once started, the daemon will:

1. Initialization: Detect installed browsers and user profiles, and load configured modules.

2. Load Modules: Load built-in modules (e.g., GitHub stars, Reddit saved posts).

3. Load Bookmarks: Load bookmarks from detected browsers and modules into the local database. This happens automatically – no manual intervention is required.

The gosuki binary offers many cli commands, use gosuki help to learn more.

Accessing Your Bookmarks

You can access and manage your bookmarks in several ways:

• Web Interface: Access the web interface by navigating to localhost:2025.

• Command Line (suki): Use the suki client for quick searches and filtering.
• Buku: Use Buku1 to manage your bookmarks.

Adding Bookmarks

Once Gosuki is running, you can add bookmarks using your browser’s native tools, and Gosuki will automatically detect and save them. Here’s how it works:

Browser Integration

• Native Shortcut: Keep browsing as usual. When you add a bookmark using your browser’s native shortcut (e.g., Ctrl+D on Linux/Windows or Cmd+D on macOS), Gosuki will detect the change and save the bookmark to its database.
• Real-Time Availability: The newly added bookmark will immediately appear in both the suki CLI tool and the web UI.

Tag Support

• Automatic Tag Detection: If you add tags to your bookmark, Gosuki will automatically pick them up and associate them with the bookmark.
• Chrome Workaround: Since Chrome doesn’t natively support tags, you can include tags directly in the bookmark title in the “Add Bookmark” popup (e.g., My Bookmark #work #notes).
• Firefox Native Support: On Firefox-based browsers, tags are supported natively through the browser’s interface.

Folder Become Tags

Bookmarks organized in browser folders will be automatically flattened into a tag-based system. For example, a bookmark in a “Work” folder might be tagged with #work automatically.

Interoperability with Buku

Gosuki is fully interoperable with Buku, a popular command-line bookmark manager. Gosuki uses the same database format as Buku, allowing you to:

• Use Buku with Real-time Bookmarks: Use Buku to manage bookmarks loaded by Gosuki, benefiting from real-time bookmark loading capabilities.

• Migrate from Buku: Seamlessly migrate your existing Buku database to Gosuki.