Categorygithub.com/luisedmc/ghcmd
modulepackage
1.0.1
Repository: https://github.com/luisedmc/ghcmd.git
Documentation: pkg.go.dev

# README

GHCMD

Forget your browser, use GitHub from the terminal.

:pushpin: About

GHCMD is a simple command line tool for GitHub with a terminal user interface. The main goal of this application is to provide an intuitive and fast way to interact with GitHub without leaving the terminal. Keep in mind that it is not a full client and does not provide all the features that GitHub has.

Tools and Libraries used:

:rocket: Installation

#  Clone the repository
git clone https://github.com/luisedmc/ghcmd.git

#  Go to the project directory
cd ghcmd

#  Run the application
go run .

You can also build the application and run it as a binary file in any directory. To do so, you build using go build and you can check here how to add the binary to your path.

:zap: Usage

The only thing you need is a GitHub API Key. You can know more about and get one here and also check the GitHub API Documentation. The first time you run the application, you will be asked to insert your token. After that, you will be able to use the application.

:dart: Features

All the main functionalities are implemented by now.
In the current version, you can:

ServiceDescription
Search RepositorySearch for a specific repository from an user
Create RepositoryCreate a repository in your GitHub account

Also, your API Key is stored locally in a database. There's no option to change it yet, so if you want to insert a new one you will need to delete the database file. It is located at ./db/data

For now, it is a work in progress and only supports a few commands. I will be always trying to add more features and improve the existing ones.

:camera_flash: Screenshots

This is how a successful search looks like

:page_facing_up: License

# Packages

No description provided by the author
No description provided by the author

# Functions

CreateRepository creates a new repository in the user account.
FetchToken returns a Github token, a status message and a status bool.
GithubClient returns a new Github client.
SearchRepository performs a search for a specific repository from an user and returns the repository information.
StartGHCMD initialize the tui by returning a model.
TestToken performs a request to the Github API to check if the token is valid.
TokenClient returns a HTTP Client from a context and a token source.
Token returns a token source.

# Structs

No description provided by the author
Repository represents a Github repository.