Connor CLI

A CLI project written in Golang for learning and experimentation purposes!
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. License
4. Contact
5. Acknowledgments

About The Project

A custom CLI for Connor by Connor. Supports list (ls), lsall (recursive list basically), greet (says hello to an input argument), cre (touch), del (remove), rename (mv filename filename), help, and running without a command.

(back to top)

Built With

As this is a project to learn Golang this is going to be almost entirely written in Go!

• 

(back to top)

Getting Started

This is just a template I will add more details to this section when this is in a more complete state.

Prerequisites

Install Go

• Here is a Great Guide

Installation

1. Clone the repo

   git clone https://github.com/ConnorRobertson/connor-cli.git

2. Change git remote url to avoid accidental pushes to base project

   git remote set-url origin ConnorRobertson/connor-cli
   git remote -v # confirm the changes

3. Compile code into a binary (Go should automatically create a binary based on your OS installation)

   go build -o connorcli cmd/main.go

4. You can now run ./connorcli

   ./connorcli -h

5. When you are done running Connor CLI you can remove the binaries with go clean

   Alternatively, if you are on Ubuntu (haven't tested any other distros) you can run the shell script it will need sudo privileges. It adds the output binary to the /usr/local/bin so you can just run connorcli

(back to top)

License

Distributed under the unlicense. See LICENSE.txt for more information.

(back to top)

Contact

Connor Robertson - robertsonc4@gmail.com

Project Link: https://github.com/ConnorRobertson/connor-cli

(back to top)

Acknowledgments

• README Template
• Cobra CLI Package

(back to top)