version & change makefile

Author: Jyny

.gitignore

@@ -4,7 +4,6 @@
 # build
 /build/
 /bin/
-/pkg/agent/script_vfsdata.go
 
 # test
 /test/

Makefile

@@ -2,40 +2,34 @@ EXECUTABLE=outliner
 WINDOWS=$(EXECUTABLE)_windows.exe
 LINUX=$(EXECUTABLE)_linux
 DARWIN=$(EXECUTABLE)_darwin
-VERSION=$(shell git describe --tags --always --long --dirty)
+VERSION=$(shell cat VERSION)
 XPKG="github.com/jyny/outliner/pkg/cmd"
 
-release : .mod pregen fmt $(LINUX) $(DARWIN) $(WINDOWS)
-	@echo version: $(VERSION)
+all : build shell_completion
+	cp ./build/outliner_$(shell go env GOOS) ./outliner
+	@echo build version: $(VERSION)
 
-$(WINDOWS):
-	env GOOS=windows GOARCH=amd64 go build -o ./build/$(WINDOWS) -ldflags="-X $(XPKG).version=$(VERSION)"  .
+shell_completion :
+	mkdir -p build
+	go run completion/gen.go
 
-$(LINUX):
+build : mod embedded fmt
 	env GOOS=linux GOARCH=amd64 go build -o ./build/$(LINUX) -ldflags="-X $(XPKG).version=$(VERSION)"  .
-
-$(DARWIN):
 	env GOOS=darwin GOARCH=amd64 go build -o ./build/$(DARWIN) -ldflags="-X $(XPKG).version=$(VERSION)"  .
+	env GOOS=windows GOARCH=amd64 go build -o ./build/$(WINDOWS) -ldflags="-X $(XPKG).version=$(VERSION)"  .
 
-.mod :
-	go mod download
-	touch .mod
-
-.PHONY : pregen
-pregen :
+embedded :
 	@pushd pkg/agent > /dev/null && \
-	go run gen/gen.go \
+ 	go run gen/gen.go \
 	&& popd > /dev/null
 
-.PHONY : mod
-mod :
-	go mod download
-
-.PHONY : fmt
 fmt :
 	gofmt -w ./
 
+mod :
+	go mod download
+
 .PHONY : clean
 clean:
 	rm -r ./build
-	rm .mod
+	rm outliner

README.md

@@ -26,7 +26,7 @@ Use "outliner [command] --help" for more information about a command.
 ```
 
 ## Contents
-- [Download](#download)
+- [Install or Download](#install-or-download)
 - [Setup](#setup)
   - [1. Get `API_TOKEN`](#1-get-api_token)
   - [2. Make a `.env` config file](#2-make-a-env-config-file)
@@ -41,18 +41,34 @@ Use "outliner [command] --help" for more information about a command.
 - [Support Cloud(IaaS)](#support-cloudiaas)
 - [Development and Build](#development-and-build)
 
-## Download
-download from latest [release](https://github.com/Jyny/outliner/releases/latest)
+## Install or Download
+### Mac OSX (wip)
+```
+$ brew isntall outliner
+```
+
+### Arch linux (wip)
+```
+# pacman -S outliner
+```
+
+### Ubuntu (wip)
+```
+# apt isntall outliner
+```
+
+### Download binary from latest release
+[https://github.com/Jyny/outliner/releases/latest](https://github.com/Jyny/outliner/releases/latest)
 
 ## Setup
-##### 1. Get `API_TOKEN`
+#### 1. Get `API_TOKEN`
 get `API_TOKEN` from cloud providers you want, like `Linode`, `DigitalOcean` and etc.
 
-##### 2. Make a `.env` config file
+#### 2. Make a `.env` config file
 write the `API_TOKEN` to `.env` file whith `TOKEN_NAME` [like this](#config-by-env-file).
 Reference the  [Support `TOKEN_NAME`](#supported-token_name) below.
 
-##### 3. Generate SSH key
+#### 3. Generate SSH key
 outliner support auto generate ssh key, if Not found `id_rsa` and `id_rsa.pub` in `$HOME/.ssh/`.
 [ssh library package](https://godoc.org/golang.org/x/crypto/ssh) outliner use, is implement by golang.org
 run any command in outliner will do this after asking.
@@ -62,10 +78,14 @@ Continue to Generate New ssh key? (y/n) [y]:
 ```
 To generate key by yourself, see [Generating a new SSH key and adding it to the ssh-agent](https://help.github.com/en/enterprise/2.16/user/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)
 
-##### 4. Ready to go
-* open terminal, go directory whrere you download outliner
-* maybe should add execute permission to binary (linux or mac)
-* `$ ./build/outliner_{OS}`
+#### 4. Ready to go
+##### * install by package manager like `homeberw` `pacman` `apt` etc.
+  1. `$ outliner`
+
+##### * install by download
+  1. open terminal, go directory whrere you download outliner
+  2. maybe should add execute permission to binary (linux or mac)
+  3. `$ ./outliner_{OS}`
 
 ## Configurations
 ### config by `.env` file
@@ -115,15 +135,11 @@ outliner Support the following configuration source (list by Precedence order)
 ...
 
 ## Development and Build
-1. install depend package
-```
-$ make mod
-```
-2. build binary
+#### 1. install package and build binary
 ```
-$ make build
+$ make
 ```
-3. run
+#### 2. run
 ```
-$ ./build/outliner_$(go env GOOS)
+$ ./outliner
 ```

VERSION

@@ -0,0 +1 @@
+v0.1.4

completion/gen.go

@@ -0,0 +1,16 @@
+package main
+
+import (
+	"github.com/jyny/outliner/pkg/cmd"
+)
+
+func main() {
+	err := cmd.RootCmd.GenBashCompletionFile("build/outliner_bash_completion")
+	if err != nil {
+		panic(err)
+	}
+	err = cmd.RootCmd.GenZshCompletionFile("build/outliner_zsh_completion")
+	if err != nil {
+		panic(err)
+	}
+}

pkg/agent/script_vfsdata.go

@@ -29,6 +29,7 @@ var rootCmd = &cobra.Command{
 	Short: "Auto setup & deploy tool for outline VPN server",
 	Long:  "Auto setup & deploy tool for outline VPN server",
 }
+var RootCmd = rootCmd
 
 // Execute entry of commandline
 func Execute() {