This is an automated email from the ASF dual-hosted git repository. rohit pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/cloudstack-cloudmonkey.git
The following commit(s) were added to refs/heads/master by this push: new 718e67e cmk: rename references to `cmk` and update README 718e67e is described below commit 718e67e7d842a5387c3e0f74525e277b12bc75ff Author: Rohit Yadav <ro...@apache.org> AuthorDate: Tue Jun 26 14:38:46 2018 +0530 cmk: rename references to `cmk` and update README Signed-off-by: Rohit Yadav <ro...@apache.org> --- Makefile | 4 ++-- README.md | 53 +++++++++++++++++++++++------------------------------ cli/completer.go | 4 ++-- cli/exec.go | 4 ++-- cli/shell.go | 2 +- cmd/api.go | 2 +- cmd/help.go | 2 +- cmd/request.go | 2 +- cmk.go | 2 +- 9 files changed, 34 insertions(+), 41 deletions(-) diff --git a/Makefile b/Makefile index e77b002..517c231 100644 --- a/Makefile +++ b/Makefile @@ -16,7 +16,7 @@ # under the License. # Makefile referenced from github.com/vincentbernat/hellogopher -PACKAGE = cloudmonkey +PACKAGE = cmk DATE ?= $(shell date +%FT%T%z) VERSION ?= $(shell git describe --tags --always --dirty --match=v* 2> /dev/null || \ cat $(CURDIR)/.version 2> /dev/null || echo v0) @@ -47,7 +47,7 @@ $(BASE): ; $(info $(M) Setting GOPATH…) @ln -sf $(CURDIR) $@ run: all - ./bin/cloudmonkey + ./bin/cmk debug: $(GO) build -gcflags='-N -l' -o cmk cmk.go && dlv --listen=:2345 --headless=true --api-version=2 exec ./cmk diff --git a/README.md b/README.md index d1bfd54..edd98ac 100644 --- a/README.md +++ b/README.md @@ -9,34 +9,26 @@ The modern cloudmonkey is a re-written and simplified port in Go and can be used with Apache CloudStack 4.9 and above. The legacy cloudmonkey written in Python can be used with Apache CloudStack 4.0-incubating and above. -### Usage - -Work in progress: 6.0.0-alpha1 (TO BE UPDATED soon) - -For modern cloudmonkey usage, please see the [usage page](https://github.com/apache/cloudstack-cloudmonkey/wiki/Usage). - -Legacy cloudmonkey can be installed using `pip install cloudmonkey`. -For legacy cloudmonkey, please see the [cwiki usage page](https://cwiki.apache.org/confluence/display/CLOUDSTACK/CloudStack+cloudmonkey+CLI). +For documentation, kindly see the [wiki](https://github.com/apache/cloudstack-cloudmonkey/wiki). ### Development -The following are various make targets you can run: +For development the pre-requisites are Go 10 or latest and a unix-like +environment. You can use the following targets for building: $ make help - all Build program binary - run Builds and runs cloudmonkey - dist Builds release for various targets - clean Cleans build artifacts - lint Run golint - fmt Run gofmt on all source files - check test tests Run tests - test-bench Run benchmarks - test-short Run only short tests - test-verbose Run tests in verbose mode with coverage reporting - test-race Run tests with race detector - test-xml Run tests with xUnit output - test-coverage Run coverage tests + all Build program binary + test-bench Run benchmarks + test-short Run only short tests + test-verbose Run tests in verbose mode with coverage reporting + test-race Run tests with race detector + check tests Run tests + test-xml Run tests with xUnit output + test-coverage Run coverage tests + debug Runs a debuggable binary using dlv + lint Run golint + fmt Run gofmt on all source files Build and run: @@ -45,7 +37,7 @@ Build and run: Build and run manually: $ make all - $ ./bin/cloudmonkey + $ ./bin/cmk ### Community @@ -69,14 +61,15 @@ Report issue(s) on the `user` mailing list and/or open a Github [issue](https:// ### History -`cloudmonkey` was originally written in Python and contributed to Apache CloudStack -project by [Rohit Yadav](http://rohityadav.cloud) on 31 Oct 2012 under the Apache -License 2.0. The original tool is also referred to as legacy cloudmonkey can -be installed using `pip install cloudmonkey`. +The original `cloudmonkey` was written in Python and contributed to Apache +CloudStack project by [Rohit Yadav](http://rohityadav.cloud) on 31 Oct 2012 +under the Apache License 2.0. The Python-based original CLI is now referred to +as the legacy cloudmonkey and can be installed using `pip install cloudmonkey`. -Starting version 6.0.0, referred to as the modern cloudmonkey, is a simplified -Go port of the original tool and ships as a standalone executable for several -targets such as Linux, Mac and Windows. +Starting version 6.0.0, the modern cloudmonkey `cmk` is a fast and simplified +Go-port of the original tool with some backward incompatibilities and reduced +feature set. It ships as a standalone 64-bit executable binary for several +platforms such as Linux, Mac and Windows. ### License diff --git a/cli/completer.go b/cli/completer.go index 9c02eff..99f10ed 100644 --- a/cli/completer.go +++ b/cli/completer.go @@ -23,8 +23,8 @@ import ( "strings" "unicode" - "cloudmonkey/cmd" - "cloudmonkey/config" + "cmk/cmd" + "cmk/config" "github.com/chzyer/readline/runes" ) diff --git a/cli/exec.go b/cli/exec.go index 17d5829..cbf5895 100644 --- a/cli/exec.go +++ b/cli/exec.go @@ -18,8 +18,8 @@ package cli import ( - "cloudmonkey/cmd" - "cloudmonkey/config" + "cmk/cmd" + "cmk/config" ) // ExecCmd executes a single provided command diff --git a/cli/shell.go b/cli/shell.go index d9ffea1..342fe25 100644 --- a/cli/shell.go +++ b/cli/shell.go @@ -22,7 +22,7 @@ import ( "io" "strings" - "cloudmonkey/config" + "cmk/config" "github.com/mattn/go-shellwords" diff --git a/cmd/api.go b/cmd/api.go index 5c0a57c..1100f55 100644 --- a/cmd/api.go +++ b/cmd/api.go @@ -27,7 +27,7 @@ import ( "sort" "strings" - "cloudmonkey/config" + "cmk/config" ) var apiCommand *Command diff --git a/cmd/help.go b/cmd/help.go index 24f654b..98d1f71 100644 --- a/cmd/help.go +++ b/cmd/help.go @@ -22,7 +22,7 @@ import ( "fmt" "strings" - "cloudmonkey/config" + "cmk/config" ) var helpCommand *Command diff --git a/cmd/request.go b/cmd/request.go index 32e059a..125ebb7 100644 --- a/cmd/request.go +++ b/cmd/request.go @@ -18,7 +18,7 @@ package cmd import ( - "cloudmonkey/config" + "cmk/config" "net/http" ) diff --git a/cmk.go b/cmk.go index 982c19a..cb72e71 100644 --- a/cmk.go +++ b/cmk.go @@ -20,7 +20,7 @@ package main import ( "os" - "cloudmonkey/cli" + "cmk/cli" ) func main() {