Added -c flag, added documentation, added to build script

Author: Forceu

build/entrypoint.sh

@@ -21,6 +21,21 @@ for target in $targets; do
 	rm $output
 done
 
+
+for target in $targets; do
+	os="$(echo $target | cut -d '/' -f1)"
+	arch="$(echo $target | cut -d '/' -f2)"
+	output="build/gokapi-cli-${os}_${arch}"
+	if [ $os = "windows" ]; then
+		output+='.exe'
+	fi
+
+	echo "----> Building Gokapi CLI for $target"
+	GOOS=$os GOARCH=$arch CGO_ENABLED=0 go build -ldflags="-s -w -X 'github.com/forceu/gokapi/internal/environment.Builder=Github Release Builder' -X 'github.com/forceu/gokapi/internal/environment.BuildTime=$(date)'" -o $output github.com/forceu/gokapi/cmd/cli-uploader
+	zip -j $output.zip $output >/dev/null
+	rm $output
+done
+
 echo "----> Build is complete. List of files at build/:"
 cd build/
 ls -l gokapi-*

cmd/cli-uploader/cliconfig/cliconfig.go

@@ -6,6 +6,7 @@ import (
 	"errors"
 	"fmt"
 	"github.com/forceu/gokapi/cmd/cli-uploader/cliapi"
+	"github.com/forceu/gokapi/cmd/cli-uploader/cliflags"
 	"github.com/forceu/gokapi/internal/helper"
 	"os"
 	"strings"
@@ -14,8 +15,6 @@ import (
 const minGokapiVersionInt = 20100
 const minGokapiVersionStr = "2.1.0"
 
-const filename = "gokapi-cli.json"
-
 type configFile struct {
 	Url    string `json:"Url"`
 	Apikey string `json:"Apikey"`
@@ -29,6 +28,8 @@ func CreateLogin() {
 		fmt.Println("ERROR: URL must start with http:// or https://")
 		os.Exit(1)
 	}
+
+	url = strings.TrimSuffix(url, "/admin")
 	if strings.HasPrefix(url, "http://") {
 		fmt.Println("WARNING: This URL uses an insecure connection. All data, including your API key, will be sent in plain text. This is not recommended for production use.")
 	}
@@ -114,16 +115,16 @@ func save(url, apikey string, e2ekey []byte) error {
 		return err
 	}
 
-	return os.WriteFile(filename, jsonData, 0600)
+	return os.WriteFile(cliflags.GetConfigLocation(), jsonData, 0600)
 }
 
 func Load() {
-	if !helper.FileExists(filename) {
+	if !helper.FileExists(cliflags.GetConfigLocation()) {
 		fmt.Println("ERROR: No login information found")
 		fmt.Println("Please run 'gokapi-cli login' to create a login")
 		os.Exit(1)
 	}
-	data, err := os.ReadFile(filename)
+	data, err := os.ReadFile(cliflags.GetConfigLocation())
 	if err != nil {
 		fmt.Println("ERROR: Could not read login information")
 		os.Exit(1)
@@ -140,8 +141,8 @@ func Load() {
 }
 
 func Delete() error {
-	if !helper.FileExists(filename) {
+	if !helper.FileExists(cliflags.GetConfigLocation()) {
 		return nil
 	}
-	return os.Remove(filename)
+	return os.Remove(cliflags.GetConfigLocation())
 }

cmd/cli-uploader/cliflags/cliflags.go

@@ -48,7 +48,7 @@ func GetUploadParameters() UploadConfig {
 			result.JsonOutput = true
 		case "--disable-e2e":
 			result.DisableE2e = true
-		case "--file":
+		case "-f":
 			result.File = getParameter(&i)
 		case "--expiry-days":
 			result.ExpiryDays = requireInt(getParameter(&i))
@@ -59,7 +59,7 @@ func GetUploadParameters() UploadConfig {
 		}
 	}
 	if result.File == "" {
-		fmt.Println("ERROR: Missing parameter --file")
+		fmt.Println("ERROR: Missing parameter -f")
 		os.Exit(2)
 	}
 	if result.ExpiryDownloads < 0 {
@@ -71,6 +71,16 @@ func GetUploadParameters() UploadConfig {
 	return result
 }
 
+func GetConfigLocation() string {
+	for i := 2; i < len(os.Args); i++ {
+		switch os.Args[i] {
+		case "-c":
+			return getParameter(&i)
+		}
+	}
+	return "gokapi-cli.json"
+}
+
 func getParameter(position *int) string {
 	newPosition := *position + 1
 	position = &newPosition
@@ -91,14 +101,14 @@ func requireInt(input string) int {
 }
 
 func printUsage() {
-	fmt.Println("Gokapi CLI")
+	fmt.Println("Gokapi CLI v1.0")
 	fmt.Println()
 	fmt.Println("Valid options are:")
-	fmt.Println("   gokapi-cli login")
-	fmt.Println("   gokapi-cli logout")
-	fmt.Println("   gokapi-cli upload --file /file/to/upload [--json] [--disable-e2e]\n" +
+	fmt.Println("   gokapi-cli login [-c /path/to/config]")
+	fmt.Println("   gokapi-cli logout [-c /path/to/config]")
+	fmt.Println("   gokapi-cli upload --f /file/to/upload [--json] [--disable-e2e]\n" +
 		"                     [--expiry-days INT] [--expiry-downloads INT]\n" +
-		"                     [--password STRING] ")
+		"                     [--password STRING] [-c /path/to/config]")
 	fmt.Println()
 	fmt.Println("gokapi-cli upload:")
 	fmt.Println("--json              Outputs the result as JSON only")

docs/advanced.rst

@@ -201,6 +201,54 @@ Migrating Redis (``127.0.0.1:6379, User: test, Password: 1234, Prefix: gokapi_,
 
  gokapi --migrate "redis://test:1234@127.0.0.1:6379?prefix=gokapi_&ssl=true" sqlite://./data/gokapi.sqlite
 
+
+
+.. _clitool:
+
+
+********************************
+CLI Tool
+********************************
+
+Gokapi also has a CLI tool that allows uploads from the command line. Binaries are avaible on the release page (``gokapi-cli``) for Linux, Windows and MacOs. To compile it yourself, download the repository and run ``make build-cli`` in the top directory.
+
+Login
+=================================
+
+First you need to login with the command ``gokapi-cli login``. You will then be asked for your server URL and a valid API key with upload permission. If end-to-end encryption is enabled, you will also need to enter your encyption key. By default the login data is saved to ``gokapi-cli.json``, but you can define a different location with the ``-c`` parameter.
+
+To logout, either delete the configuration file or run ``gokapi-cli logout``.
+
+.. warning::
+
+   The configuration file contains the login data as plain text.
+
+
+Upload
+=================================
+
+
+To upload a file, simply run ``gokapi-cli upload -f /path/to/file``. By default the files are encrypted (if enabled) and stored without any expiration. These additional parameters are available:
+
++-----------------------------+---------------------------------------------------+
+| --json                      | Only outputs in JSON format, unless upload failed |
++-----------------------------+---------------------------------------------------+
+| --disable-e2e               | Disables end-to-end encryption for this upload    |
++-----------------------------+---------------------------------------------------+
+| --expiry-days [number]      | Sets the expiry date of the file in days          |
++-----------------------------+---------------------------------------------------+
+| --expiry-downloads [number] | Sets the allowed downloads                        |
++-----------------------------+---------------------------------------------------+
+| --password [string]         | Sets a password                                   |
++-----------------------------+---------------------------------------------------+
+| -c [path]                   | Use the configuration file specified              |
++-----------------------------+---------------------------------------------------+
+
+
+.. warning::
+
+   If you are using end-to-end encryption, do not upload other encrypted files simultaneously to avoid race conditions. 
+   
 .. _api: