feat!: update cli commands (#211)

* docs: add configuration page, update intro

* docs: add cli commands in tour section

* docs: add intro page to tour

* docs: add tabs in guides

* docs: update guides with cli commands

* docs: upate installation and configuration

* fix: cli

* docs: add cli reference, make doc, update api

* cli: add version command

* cli: add shell completion command

* cli: add environment command

* refactor: make server cmd to start and migrate

* feat(cli): add asset commands

* docs: update cli commands

* refactor: cli config cmd, add config init

* chore: add changes from suggestions

* fix: start and migrate server with config flag

* chore: add changes from suggestions

* revert: docs

* revert: docs

* chore: add changes from suggestion

* chore: add changes from suggestions

* chore: add changes from suggestion

* fix: load config, add persistant flag overloading

* chore: load config from current directory first

* chore: get asset with urn instead of id

Author: Chief-Rishab

.goreleaser.yml

@@ -11,9 +11,9 @@ builds:
     binary: compass
     flags: [-a]
     ldflags:
-      - -X github.com/odpf/compass/cmd.Version={{.Tag}}
-      - -X github.com/odpf/compass/cmd.BuildCommit={{.FullCommit}}
-      - -X github.com/odpf/compass/cmd.BuildDate={{.Date}}
+      - -X github.com/odpf/compass/cli.Version={{.Tag}}
+      - -X github.com/odpf/compass/cli.BuildCommit={{.FullCommit}}
+      - -X github.com/odpf/compass/cli.BuildDate={{.Date}}
     goos: [linux, darwin, windows]
     goarch: [amd64, 386, arm, arm64] # skip goarch 386 and arm due to conflicts with "github.com/blastrain/vitess-sqlparser" library
     env:

Makefile

@@ -6,28 +6,28 @@ PROTON_COMMIT := "c7639b42da0679b2340a52155d2fe577b9d45aa2"
 
 all: build
 
-build:
-	go build -ldflags "-X cmd.Version=${VERSION}" ${NAME}
+build: ## Build the compass binary
+	go build -ldflags "-X ${NAME}/cli.Version=${VERSION}" 
 
-clean:
-	rm -rf compass dist/
+clean:  ## Clean the build artifacts
+	rm -rf compass dist/ 
 
-test:
+test: ## Run the tests
 	go test -race ./... -coverprofile=coverage.txt
 
-test-coverage: test
+test-coverage: test ## Print the code coverage
 	go tool cover -html=coverage.txt -o cover.html
 
-e2e-test:
+e2e-test: ## Run all e2e tests
 	go test ./test/... --tags=e2e
 
-generate:
+generate: ## Run all go generate in the code base 
 	go generate ./...
 
 dist:
 	@bash ./scripts/build.sh
 
-lint:
+lint: ## Lint checker
 	golangci-lint run
 
 proto: ## Generate the protobuf files
@@ -36,7 +36,7 @@ proto: ## Generate the protobuf files
 	@buf generate https://github.com/odpf/proton/archive/${PROTON_COMMIT}.zip#strip_components=1 --template buf.gen.yaml --path odpf/compass -v
 	@echo " > protobuf compilation finished"
 
-install: ## install required dependencies
+install: ## Install required dependencies
 	@echo "> installing dependencies"
 	go mod tidy
 	go install github.com/vektra/mockery/[email protected]
@@ -46,3 +46,15 @@ install: ## install required dependencies
 
 update-swagger-md:
 	npx swagger-markdown -i proto/compass.swagger.yaml -o docs/docs/reference/api.md
+
+clean-doc:
+	@echo "> cleaning up auto-generated docs"
+	@rm -rf ./docs/docs/reference/cli.md
+	@rm -f ./docs/docs/reference/api.md
+
+doc: clean-doc update-swagger-md ## Generate api and cli references
+	@echo "> generate cli docs"
+	@go run . reference --plain | sed '1 s,.*,# CLI,' > ./docs/docs/reference/cli.md
+ 
+help: ## Display this help message
+	@cat $(MAKEFILE_LIST) | grep -e "^[a-zA-Z_\-]*: *.*## *" | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'