rk

README

rk-cmd

Rookie command line tools. It contains lots of useful utility tools including downloading dependencies, generate Go files from proto files etc.

rk lets you:

• Install third party command lint tools
• Generate Go files, gRpc go files and swagger json files

Table of Contents generated with DocToc

• Installation
• Quick Start
• Command Overview
  • rk help
  • rk install
  • rk uninstall
  • rk gen
  • rk test
• Development Status: Stable
• Contributing

Installation

go install github.com/rookie-ninja/rk

Quick Start

We'll start with a general overview of the commands. There are more commands, and we will get into] usage below, but this shows the basic functionality.

   install    Install third-party software
   uninstall  Uninstall third-party software
   gen        Generate files
   test       Run unit test
   help, h    Shows a list of commands or help for one command

Command Overview

rk help

rk help

Print help message

rk install

rk install 

Subcommands

COMMANDS:
   protobuf                 install protobuf on local machine
   protoc-gen-go            install protoc-gen-go on local machine
   protoc-gen-grpc-gateway  install protoc-gen-grpc-gateway on local machine
   protoc-gen-swagger       install protoc-gen-swagger on local machine
   protoc-gen-doc           install protoc-gen-doc on local machine
   golint                   install golint on local machine
   golangci-lint            install golangci-lint on local machine
   gocov                    install gocov on local machine
   mockgen                  install mockgen on local machine
   swag                     install swag on local machine
   rk-std                   install rk standard environment on local machine
   cfssl                    install cfssl on local machine
   cfssljson                install cfssljson on local machine
   help, h                  Shows a list of commands or help for one command

rk uninstall

rk uninstall 

Subcommands

COMMANDS:
   swag                uninstall swag on local machine
   gocov               uninstall gocov on local machine
   golint              uninstall golint on local machine
   golangci-lint       uninstall golangci-lint on local machine
   golangci-lint       uninstall golangci-lint on local machine
   protobuf            uninstall protobuf on local machine
   protoc-gen-doc      uninstall protoc-gen-doc on local machine
   protoc-gen-go       uninstall protoc-gen-go on local machine
   protoc-gen-swagger  uninstall protoc-gen-swagger on local machine
   rk-std              uninstall rk standard environment on local machine
   cfssl               uninstall cfssl on local machine
   cfssljson           uninstall cfssljson on local machine
   help, h             Shows a list of commands or help for one command

rk gen

rk gen # Generate files from proto

Subcommands

COMMANDS:
   pb-go    generate go & doc file from proto
   pb-doc   generate documentation from proto
   test     Run unit test
   help, h  Shows a list of commands or help for one command

rk test

rk test # Run unit test

Subcommands

COMMANDS:
   ut-go    run unit test in golang
   help, h  Shows a list of commands or help for one command

Development Status: Stable

Contributing

We encourage and support an active, healthy community of contributors — including you! Details are in the contribution guide and the code of conduct. The rk maintainers keep an eye on issues and pull requests, but you can also report any negative conduct to dongxuny@gmail.com. That email list is a private, safe space; even the zap maintainers don't have access, so don't hesitate to hold us to a high standard.

---

Released under the MIT License.

Documentation

Overview

Copyright (c) 2020 rookie-ninja

Use of this source code is governed by an MIT-style license that can be found in the LICENSE file.