Allow overriding of CLI install path and config dir (#1521)

Author: deliahu

cli/cmd/root.go

@@ -26,6 +26,7 @@ import (
 	"github.com/cortexlabs/cortex/cli/types/flags"
 	"github.com/cortexlabs/cortex/pkg/lib/errors"
 	"github.com/cortexlabs/cortex/pkg/lib/exit"
+	"github.com/cortexlabs/cortex/pkg/lib/files"
 	libjson "github.com/cortexlabs/cortex/pkg/lib/json"
 	s "github.com/cortexlabs/cortex/pkg/lib/strings"
 	"github.com/cortexlabs/cortex/pkg/lib/telemetry"
@@ -72,7 +73,13 @@ func init() {
 	}
 	_homeDir = s.EnsureSuffix(homeDir, "/")
 
-	_localDir = filepath.Join(homeDir, ".cortex")
+	_localDir = os.Getenv("CORTEX_CLI_CONFIG_DIR")
+	if _localDir != "" {
+		_localDir = files.UserRelToAbsPath(_localDir)
+	} else {
+		_localDir = filepath.Join(homeDir, ".cortex")
+	}
+
 	err = os.MkdirAll(_localDir, os.ModePerm)
 	if err != nil {
 		err := errors.Wrap(err, "unable to write to home directory", _localDir)

cli/local/config.go

@@ -22,6 +22,7 @@ import (
 
 	"github.com/cortexlabs/cortex/pkg/lib/errors"
 	"github.com/cortexlabs/cortex/pkg/lib/exit"
+	"github.com/cortexlabs/cortex/pkg/lib/files"
 	s "github.com/cortexlabs/cortex/pkg/lib/strings"
 	"github.com/mitchellh/go-homedir"
 )
@@ -45,7 +46,13 @@ func init() {
 		exit.Error(err)
 	}
 
-	_localDir = filepath.Join(homeDir, ".cortex")
+	_localDir = os.Getenv("CORTEX_CLI_CONFIG_DIR")
+	if _localDir != "" {
+		_localDir = files.UserRelToAbsPath(_localDir)
+	} else {
+		_localDir = filepath.Join(homeDir, ".cortex")
+	}
+
 	err = os.MkdirAll(_localDir, os.ModePerm)
 	if err != nil {
 		err := errors.Wrap(err, "unable to write to home directory", _localDir)

dev/cli_md_template.md

@@ -20,6 +20,10 @@ $ bash -c "$(curl -sS https://raw.githubusercontent.com/cortexlabs/cortex/vINSER
 $ bash -c "$(curl -sS https://raw.githubusercontent.com/cortexlabs/cortex/v0.18.1/get-cli.sh)"
 ```
 
+By default, the Cortex CLI is installed at `/usr/local/bin/cortex`. To install the executable elsewhere, export the `CORTEX_INSTALL_PATH` environment variable to your desired location before running the command above.
+
+By default, the Cortex CLI creates a directory at `~/.cortex/` and uses it to store environment configuration. To use a different directory, export the `CORTEX_CLI_CONFIG_DIR` environment variable before running a `cortex` command.
+
 ### Windows
 
 To install the Cortex CLI on a Windows machine, follow [this guide](../guides/windows-cli.md).

docs/miscellaneous/cli.md

@@ -20,6 +20,10 @@ $ bash -c "$(curl -sS https://raw.githubusercontent.com/cortexlabs/cortex/vINSER
 $ bash -c "$(curl -sS https://raw.githubusercontent.com/cortexlabs/cortex/v0.18.1/get-cli.sh)"
 ```
 
+By default, the Cortex CLI is installed at `/usr/local/bin/cortex`. To install the executable elsewhere, export the `CORTEX_INSTALL_PATH` environment variable to your desired location before running the command above.
+
+By default, the Cortex CLI creates a directory at `~/.cortex/` and uses it to store environment configuration. To use a different directory, export the `CORTEX_CLI_CONFIG_DIR` environment variable before running a `cortex` command.
+
 ### Windows
 
 To install the Cortex CLI on a Windows machine, follow [this guide](../guides/windows-cli.md).

get-cli.sh

@@ -17,6 +17,10 @@
 set -e
 
 CORTEX_VERSION_BRANCH_STABLE=master
+CORTEX_INSTALL_PATH="${CORTEX_INSTALL_PATH:-/usr/local/bin/cortex}"
+
+# replace ~ with the home directory path
+CORTEX_INSTALL_PATH="${CORTEX_INSTALL_PATH/#\~/$HOME}"
 
 case "$OSTYPE" in
   darwin*)  parsed_os="darwin" ;;
@@ -25,7 +29,7 @@ case "$OSTYPE" in
 esac
 
 function main() {
-  echo -e "\ndownloading cli (/usr/local/bin/cortex) ...\n"
+  echo -e "\ndownloading cli (${CORTEX_INSTALL_PATH}) ...\n"
 
   cortex_sh_tmp_dir="$HOME/.cortex-sh-tmp"
   rm -rf $cortex_sh_tmp_dir && mkdir -p $cortex_sh_tmp_dir
@@ -42,10 +46,10 @@ function main() {
   chmod +x $cortex_sh_tmp_dir/cortex
 
   if [ $(id -u) = 0 ]; then
-    mv -f $cortex_sh_tmp_dir/cortex /usr/local/bin/cortex
+    mv -f $cortex_sh_tmp_dir/cortex $CORTEX_INSTALL_PATH
   else
     ask_sudo
-    sudo mv -f $cortex_sh_tmp_dir/cortex /usr/local/bin/cortex
+    sudo mv -f $cortex_sh_tmp_dir/cortex $CORTEX_INSTALL_PATH
   fi
 
   rm -rf $cortex_sh_tmp_dir

pkg/lib/files/files.go

@@ -243,7 +243,8 @@ func RelToAbsPath(relativePath string, baseDir string) string {
 	if !IsAbsOrTildePrefixed(relativePath) {
 		relativePath = filepath.Join(baseDir, relativePath)
 	}
-	return filepath.Clean(relativePath)
+	cleanPath, _ := Clean(relativePath)
+	return cleanPath
 }
 
 func UserRelToAbsPath(relativePath string) string {