Skip to content
Command line tool to interact with Goodreads
Go Makefile
Branch: master
Clone or download
ajbosco Merge pull request #11 from ajbosco/dependabot/go_modules/github.com/…
…stretchr/testify-1.4.0

Bump github.com/stretchr/testify from 1.3.0 to 1.4.0
Latest commit 20361bc Sep 10, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cmd/reads goreportcard (#3) Sep 27, 2018
goodreads
img Screenshot (#2) Sep 27, 2018
utils initial commit Sep 27, 2018
version
.gitignore initial commit Sep 27, 2018
.goosarch initial commit Sep 27, 2018
.travis.yml Add .travis.yml and badge (#1) Sep 27, 2018
LICENSE.txt initial commit Sep 27, 2018
Makefile Makefile: fix make help Nov 25, 2018
README.md
VERSION.txt bump version to 0.1.1 Nov 5, 2018
go.mod Bump github.com/stretchr/testify from 1.3.0 to 1.4.0 Sep 10, 2019
go.sum Bump github.com/stretchr/testify from 1.3.0 to 1.4.0 Sep 10, 2019

README.md

reads

Travis CI Go Report Card GoDoc

Command line tool to interact with Goodreads.

screenshot

Installation

Binaries

For installation instructions from binaries please visit the Releases Page.

With Go

$ go get github.com/ajbosco/reads

Authentication

  1. Create a Developer Key with Goodreads
  2. Create a config.yml file
DeveloperKey: your-developer-key
DeveloperSecret: your-developer-secret
  1. Set the config filepath as GOODREADS_CLI_CONFIG environment variable.
export GOODREADS_CLI_CONFIG=path/to/your/config.yml

Usage

$ reads -h
NAME:
   reads - Command line tool to interact with Goodreads

USAGE:
   reads [global options] command [command options] [arguments...]

COMMANDS:
     search   search for a book by title, author, or id
     shelves  view shelves and add books to them
     help, h  Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --config value, -c value  Goodreads CLI config file [$GOODREADS_CLI_CONFIG]
   --debug, -d               enable debug logging
   --help, -h                show help
   --version, -v             print the version

Search for Book

$ reads search -h
NAME:
   reads search - search for a book by title, author, or id

USAGE:
   reads search [arguments...]

List Shelves

$ reads shelves list -h
NAME:
   reads shelves list - list your shelves

USAGE:
   reads shelves list [arguments...]

Show Books on Shelf

$ reads shelves show -h
NAME:
   reads shelves show - show books on shelf

USAGE:
   reads shelves show [command options] [arguments...]

OPTIONS:
   --shelf value, -s value  -s=shelf-name

Add Book to Shelf

$ reads shelves add -h
NAME:
   reads shelves add - add a book to shelf

USAGE:
   reads shelves add [command options] [arguments...]

OPTIONS:
   --shelf value, -s value    -s=shelf-name
   --book-id value, -b value  -b=book-id
You can’t perform that action at this time.