anchor

command module
v0.2.1 Latest Latest
Warning

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

Go to latest
Published: Mar 2, 2024 License: GPL-3.0 Imports: 3 Imported by: 0

README


Go Report Card CI GitHub release (with filter)


Anchor is a simple CLI tool for storing bookmarks neatly organized in a flattened label hierarchy. It features a custom and intuitive TUI via bubbletea and automatic syncing with git via go-git as a backing storage.

Installation

Download one of the pre-built binaries and make it available for the shell you are using. Make sure to grab the right one for the operating system/architecture you intend to use it on.

Build from source

Prerequisites to build anchor from source:

  • Go 1.21 or later

Build and place it under $GOBIN:

 go install github.com/loghinalexandru/anchor@latest

Storage

For now by default it uses the local file system as storage. You can specify what kind of backing storage you want via a config file explained in the next section.

Valid options:

  • local
  • git via ssh auth

Usage

In order to use anchor you first need to create a home for all your bookmarks. Before any operation you need to initialize the storage by running the following command:

anchor init

In order to change the default behaviour create a file under ~/.config/anchor/anchor.yaml with the following config values:

storage: git # Use git as backing storage (default: local)
path: /Users/anchor-user # Change storage path (default: ~/)
sync: none # Change sync mode from (default: always)

For this to work you need to have a repository already created and a ssh key already setup. The authentication is done via ssh-agent as mentioned in the go-git documentation.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

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