get started

From zero to first saved link in under a minute.

Four steps to get shelf running, then everything you need to start organizing links from your terminal.

01

Install Go

shelf is a Go binary — you'll need Go 1.21 or newer on your machine.

$ go version
# go1.21 or higher
02

Clone & build

Pull the source and compile it into a single local binary.

$ git clone https://github.com/biplob-codes/shelf-cli.git
$ cd shelf-cli
$ go build -o shelf .
03

Move it onto your PATH

So you can run shelf from any directory, not just this one.

$ mv shelf /usr/local/bin/
04

Run it once

First run creates and migrates a local shelf.db SQLite file in the current directory.

$ shelf --help

Core commands

Run shelf --help or shelf <command> --help any time for full flag details.

Collections — alias: shelf c

$ shelf collection create work

create a new collection

$ shelf collection list

list all collections

$ shelf collection update work archive

rename "work" to "archive"

$ shelf collection delete archive

delete a collection

Links — aliases: shelf lnk, shelf l

$ shelf link add https://example.com -t news -c reading-list

save a link

$ shelf link list -c reading-list

list links in a collection

$ shelf link list

list uncategorized links

$ shelf link update 3 tech-articles

retag a link by id

$ shelf link delete 3

delete a link by id

Want the details?

See how shelf is built under the hood.

Read about shelf