awesome-cli

awesome-cli

Awesome CLI is a simple and immature command line tool to give you a fancy command line interface to dive into Awesome lists.

• Introduction
• How To Install And Use
  • Basic
  • Build as binary
  • Download and use oficial binary
  • CLI Options
  • Sample Execution
• How To Contribute

Introduction

The CLI starts with the root repository sindresorhus/awesome and guides to to the final repo according to your choices. It fetches Readme files of the repositories and parses them to create the select lists. So, the CLI needs a working network :). It also uses file caches to cache the Readme file contents. You can find the cache folder with name ".awsomecache" under your home folder.

How To Install And Use

Basic

Follow the steps;

> $ git clone git@github.com:umutphp/awesome-cli.git
> $ cd awesome-cli
> $ go run main.go

Build as binary

Follow the steps;

> $ git clone git@github.com:umutphp/awesome-cli.git
> $ cd awesome-cli
> $ sudo go build -o /usr/local/bin/awesome-cli .
> $ awesome-cli

Download and use oficial binary

Visit the latest release page and download the binary correspondingly.

> $ wget -O /usr/local/bin/awesome-cli https://latest-binary-url
> $ awesome-cli

CLI Options

The CLI works in interactive mode without any given option. But, It can be also called some options described below;

> $ awesome-cli help
aweome-cli Version 0.2.0

Options of awesome-cli:
  help      To print this screen.
  random    To go to a random awesome content.
  surprise  To go to a surprise awesome content according to your previos choices.

Sample Execution

> $ go run main.go
aweome-cli Version 0.2.0
✔ Platforms
✔ Linux
✔ Applications
✔ Gedit
https://wiki.gnome.org/Apps/Gedit

How To Contribute

Please follow the instructions in CONTRIBUTING file and beware of CODE_OF_CONDUCT.