{"id":17359928,"url":"https://github.com/ajbosco/reads","last_synced_at":"2025-04-15T00:11:52.487Z","repository":{"id":52450201,"uuid":"150514070","full_name":"ajbosco/reads","owner":"ajbosco","description":"Command line tool to interact with Goodreads ","archived":false,"fork":false,"pushed_at":"2021-04-28T22:37:10.000Z","size":196,"stargazers_count":14,"open_issues_count":6,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-15T00:11:42.304Z","etag":null,"topics":["cli","command-line","go","golang","goodreads","goodreads-api"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ajbosco.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-09-27T02:00:12.000Z","updated_at":"2021-07-15T03:27:08.000Z","dependencies_parsed_at":"2022-08-19T11:33:09.211Z","dependency_job_id":null,"html_url":"https://github.com/ajbosco/reads","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajbosco%2Freads","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajbosco%2Freads/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajbosco%2Freads/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ajbosco%2Freads/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ajbosco","download_url":"https://codeload.github.com/ajbosco/reads/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248981270,"owners_count":21193147,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","command-line","go","golang","goodreads","goodreads-api"],"created_at":"2024-10-15T19:13:35.384Z","updated_at":"2025-04-15T00:11:52.469Z","avatar_url":"https://github.com/ajbosco.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# reads\n\n[![Travis CI](https://img.shields.io/travis/ajbosco/reads.svg?style=flat-square)](https://travis-ci.org/ajbosco/reads)\n[![Go Report Card](https://goreportcard.com/badge/github.com/ajbosco/reads?style=flat-square)](https://goreportcard.com/report/github.com/ajbosco/reads)\n[![GoDoc](https://img.shields.io/badge/godoc-reference-5272B4.svg?style=flat-square)](https://godoc.org/github.com/ajbosco/reads/goodreads)\n\nCommand line tool to interact with [Goodreads](https://www.goodreads.com).\n\n![screenshot](/img/screenshot.png)\n\n- [Installation](#installation)\n    + [Binaries](#binaries)\n    + [With Go](#with-go)\n- [Authentication](#authentication)\n- [Usage](#usage)\n  * [Search for Book](#search-for-book)\n  * [List Shelves](#list-shelves)\n  * [Show Books on Shelf](#show-books-on-shelf)\n  * [Add Book to Shelf](#add-book-to-shelf)\n\n## Installation\n\n#### Binaries\n\nFor installation instructions from binaries please visit the [Releases Page](https://github.com/ajbosco/reads/releases).\n\n#### With Go\n\n```console\n$ go get github.com/ajbosco/reads/cmd/reads\n```\n\n## Authentication\n\n1. Create a Developer Key with [Goodreads](https://www.goodreads.com/api/keys)\n2. Create a `config.yml` file\n```console\nDeveloperKey: your-developer-key\nDeveloperSecret: your-developer-secret\n```\n3. Set the config filepath as `GOODREADS_CLI_CONFIG` environment variable.\n```console\nexport GOODREADS_CLI_CONFIG=path/to/your/config.yml\n```\n \n## Usage\n\n```console\n$ reads -h\nNAME:\n   reads - Command line tool to interact with Goodreads\n\nUSAGE:\n   reads [global options] command [command options] [arguments...]\n\nCOMMANDS:\n     search   search for a book by title, author, or id\n     shelves  view shelves and add books to them\n     help, h  Shows a list of commands or help for one command\n\nGLOBAL OPTIONS:\n   --config value, -c value  Goodreads CLI config file [$GOODREADS_CLI_CONFIG]\n   --debug, -d               enable debug logging\n   --help, -h                show help\n   --version, -v             print the version\n```\n\n### Search for Book\n\n```console\n$ reads search -h\nNAME:\n   reads search - search for a book by title, author, or id\n\nUSAGE:\n   reads search [arguments...]\n```\n\n### List Shelves\n\n```console\n$ reads shelves list -h\nNAME:\n   reads shelves list - list your shelves\n\nUSAGE:\n   reads shelves list [arguments...]\n```\n\n### Show Books on Shelf\n\n```console\n$ reads shelves show -h\nNAME:\n   reads shelves show - show books on shelf\n\nUSAGE:\n   reads shelves show [command options] [arguments...]\n\nOPTIONS:\n   --shelf value, -s value  -s=shelf-name\n```\n\n### Add Book to Shelf\n\n```console\n$ reads shelves add -h\nNAME:\n   reads shelves add - add a book to shelf\n\nUSAGE:\n   reads shelves add [command options] [arguments...]\n\nOPTIONS:\n   --shelf value, -s value    -s=shelf-name\n   --book-id value, -b value  -b=book-id\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fajbosco%2Freads","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fajbosco%2Freads","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fajbosco%2Freads/lists"}