update

CHANGELOG.md

@@ -14,6 +14,7 @@
 - `pkg/request,pkg/response`: update interfaces: IRequestBuilder, IResponseBuilder
 - `hidden-lake`: move GVersion, GSettings, GNetworks from root dir -> to build/ dir
 - `build`: default work_size_bits=22 -> work_size_bits=0
+- `cmd/*`: add help.yml
 
 <!-- ... -->
 

cmd/hla/common/help.yml

@@ -0,0 +1,7 @@
+name: Hidden Lake Adapter = Common (HLA=common)
+desc: adapts HL traffic to a custom HTTP server
+args: |
+  [ -h, --help    ] - print information about service
+  [ -v, --version ] - print version of service
+  [ -p, --path    ] - set path to config, database files
+  [ -n, --network ] - set network key for connections

cmd/hla/common/main.go

@@ -12,6 +12,14 @@ import (
 	"github.com/number571/hidden-lake/build"
 	"github.com/number571/hidden-lake/internal/adapters/common/pkg/app"
 	"github.com/number571/hidden-lake/internal/utils/flag"
+	"github.com/number571/hidden-lake/internal/utils/help"
+
+	_ "embed"
+)
+
+var (
+	//go:embed help.yml
+	gHelpYaml []byte
 )
 
 func main() {
@@ -23,15 +31,7 @@ func main() {
 	}
 
 	if flag.GetBoolFlagValue(args, []string{"h", "help"}) {
-		fmt.Print(
-			"Hidden Lake Adapter = Common (HLA=common)\n" +
-				"Description: adapts HL traffic to a custom HTTP server\n" +
-				"Arguments:\n" +
-				"[ -h, --help    ] - print information about service\n" +
-				"[ -v, --version ] - print version of service\n" +
-				"[ -p, --path    ] - set path to config, database files\n" +
-				"[ -n, --network ] - set network key for connections\n",
-		)
+		help.Println(gHelpYaml)
 		return
 	}
 

cmd/hlc/help.yml

@@ -0,0 +1,8 @@
+name: Hidden Lake Composite (HLC)
+desc: runs many HL services as one application
+args: |
+  [ -h, --help    ] - print information about service
+  [ -v, --version ] - print version of service
+  [ -p, --path    ] - set path to config, database files
+  [ -n, --network ] - set network key for connections
+  [ -t, --threads ] - set num of parallel functions to calculate PoW

cmd/hlc/main.go

@@ -11,6 +11,14 @@ import (
 	"github.com/number571/hidden-lake/build"
 	"github.com/number571/hidden-lake/internal/composite/pkg/app"
 	"github.com/number571/hidden-lake/internal/utils/flag"
+	"github.com/number571/hidden-lake/internal/utils/help"
+
+	_ "embed"
+)
+
+var (
+	//go:embed help.yml
+	gHelpYaml []byte
 )
 
 func main() {
@@ -22,16 +30,7 @@ func main() {
 	}
 
 	if flag.GetBoolFlagValue(args, []string{"h", "help"}) {
-		fmt.Print(
-			"Hidden Lake Composite (HLC)\n" +
-				"Description: runs many HL services as one application\n" +
-				"Arguments:\n" +
-				"[ -h, --help    ] - print information about service\n" +
-				"[ -v, --version ] - print version of service\n" +
-				"[ -p, --path    ] - set path to config, database files\n" +
-				"[ -n, --network ] - set network key for connections\n" +
-				"[ -t, --threads ] - set num of parallel functions to calculate PoW\n",
-		)
+		help.Println(gHelpYaml)
 		return
 	}
 

cmd/hle/help.yml

@@ -0,0 +1,8 @@
+name: Hidden Lake Encryptor (HLE)
+desc: encrypts and decrypts messages
+args: |
+  [ -h, --help    ] - print information about service
+  [ -v, --version ] - print version of service
+  [ -p, --path    ] - set path to config, database files
+  [ -n, --network ] - set network key for connections
+  [ -t, --threads ] - set num of parallel functions to calculate PoW

cmd/hle/main.go

@@ -12,6 +12,14 @@ import (
 	"github.com/number571/hidden-lake/build"
 	"github.com/number571/hidden-lake/internal/helpers/encryptor/pkg/app"
 	"github.com/number571/hidden-lake/internal/utils/flag"
+	"github.com/number571/hidden-lake/internal/utils/help"
+
+	_ "embed"
+)
+
+var (
+	//go:embed help.yml
+	gHelpYaml []byte
 )
 
 func main() {
@@ -23,16 +31,7 @@ func main() {
 	}
 
 	if flag.GetBoolFlagValue(args, []string{"h", "help"}) {
-		fmt.Print(
-			"Hidden Lake Encryptor (HLE)\n" +
-				"Description: encrypts and decrypts messages\n" +
-				"Arguments:\n" +
-				"[ -h, --help    ] - print information about service\n" +
-				"[ -v, --version ] - print version of service\n" +
-				"[ -p, --path    ] - set path to config, database files\n" +
-				"[ -n, --network ] - set network key for connections\n" +
-				"[ -t, --threads ] - set num of parallel functions to calculate PoW\n",
-		)
+		help.Println(gHelpYaml)
 		return
 	}
 

cmd/hlf/help.yml

@@ -0,0 +1,6 @@
+name: Hidden Lake Filesharer (HLF)
+desc: file sharing with a web interface
+args: |
+  [ -h, --help    ] - print information about service
+  [ -v, --version ] - print version of service
+  [ -p, --path    ] - set path to config, database files

cmd/hlf/main.go

@@ -12,6 +12,14 @@ import (
 	"github.com/number571/hidden-lake/build"
 	"github.com/number571/hidden-lake/internal/applications/filesharer/pkg/app"
 	"github.com/number571/hidden-lake/internal/utils/flag"
+	"github.com/number571/hidden-lake/internal/utils/help"
+
+	_ "embed"
+)
+
+var (
+	//go:embed help.yml
+	gHelpYaml []byte
 )
 
 func main() {
@@ -23,14 +31,7 @@ func main() {
 	}
 
 	if flag.GetBoolFlagValue(args, []string{"h", "help"}) {
-		fmt.Print(
-			"Hidden Lake Filesharer (HLF)\n" +
-				"Description: file sharing with a web interface\n" +
-				"Arguments:\n" +
-				"[ -h, --help    ] - print information about service\n" +
-				"[ -v, --version ] - print version of service\n" +
-				"[ -p, --path    ] - set path to config, database files\n",
-		)
+		help.Println(gHelpYaml)
 		return
 	}
 

cmd/hll/help.yml

@@ -0,0 +1,7 @@
+name: Hidden Lake Loader (HLL)
+desc: distributes the stored traffic between nodes
+args: |
+  [ -h, --help    ] - print information about service
+  [ -v, --version ] - print version of service
+  [ -p, --path    ] - set path to config, database files
+  [ -n, --network ] - set network key for connections

cmd/hll/main.go

@@ -12,6 +12,14 @@ import (
 	"github.com/number571/hidden-lake/build"
 	"github.com/number571/hidden-lake/internal/helpers/loader/pkg/app"
 	"github.com/number571/hidden-lake/internal/utils/flag"
+	"github.com/number571/hidden-lake/internal/utils/help"
+
+	_ "embed"
+)
+
+var (
+	//go:embed help.yml
+	gHelpYaml []byte
 )
 
 func main() {
@@ -23,15 +31,7 @@ func main() {
 	}
 
 	if flag.GetBoolFlagValue(args, []string{"h", "help"}) {
-		fmt.Print(
-			"Hidden Lake Loader (HLL)\n" +
-				"Description: distributes the stored traffic between nodes\n" +
-				"Arguments:\n" +
-				"[ -h, --help    ] - print information about service\n" +
-				"[ -v, --version ] - print version of service\n" +
-				"[ -p, --path    ] - set path to config, database files\n" +
-				"[ -n, --network ] - set network key for connections\n",
-		)
+		help.Println(gHelpYaml)
 		return
 	}
 

cmd/hlm/help.yml

@@ -0,0 +1,6 @@
+name: Hidden Lake Messenger (HLM)
+desc: messenger with a web interface
+args: |
+  [ -h, --help    ] - print information about service
+  [ -v, --version ] - print version of service
+  [ -p, --path    ] - set path to config, database files

cmd/hlm/main.go

@@ -14,6 +14,14 @@ import (
 	"github.com/number571/hidden-lake/build"
 	"github.com/number571/hidden-lake/internal/applications/messenger/pkg/app"
 	"github.com/number571/hidden-lake/internal/utils/flag"
+	"github.com/number571/hidden-lake/internal/utils/help"
+
+	_ "embed"
+)
+
+var (
+	//go:embed help.yml
+	gHelpYaml []byte
 )
 
 func main() {
@@ -25,14 +33,7 @@ func main() {
 	}
 
 	if flag.GetBoolFlagValue(args, []string{"h", "help"}) {
-		fmt.Print(
-			"Hidden Lake Messenger (HLM)\n" +
-				"Description: messenger with a web interface\n" +
-				"Arguments:\n" +
-				"[ -h, --help    ] - print information about service\n" +
-				"[ -v, --version ] - print version of service\n" +
-				"[ -p, --path    ] - set path to config, database files\n",
-		)
+		help.Println(gHelpYaml)
 		return
 	}
 

cmd/hlr/help.yml

@@ -0,0 +1,6 @@
+name: Hidden Lake Remoter (HLR)
+desc: executes remote access commands
+args: |
+  [ -h, --help    ] - print information about service
+  [ -v, --version ] - print version of service
+  [ -p, --path    ] - set path to config, database files

cmd/hlr/main.go

@@ -12,6 +12,14 @@ import (
 	"github.com/number571/hidden-lake/build"
 	"github.com/number571/hidden-lake/internal/applications/remoter/pkg/app"
 	"github.com/number571/hidden-lake/internal/utils/flag"
+	"github.com/number571/hidden-lake/internal/utils/help"
+
+	_ "embed"
+)
+
+var (
+	//go:embed help.yml
+	gHelpYaml []byte
 )
 
 func main() {
@@ -23,14 +31,7 @@ func main() {
 	}
 
 	if flag.GetBoolFlagValue(args, []string{"h", "help"}) {
-		fmt.Print(
-			"Hidden Lake Remoter (HLR)\n" +
-				"Description: executes remote access commands\n" +
-				"Arguments:\n" +
-				"[ -h, --help    ] - print information about service\n" +
-				"[ -v, --version ] - print version of service\n" +
-				"[ -p, --path    ] - set path to config, database files\n",
-		)
+		help.Println(gHelpYaml)
 		return
 	}
 

cmd/hls/help.yml

@@ -0,0 +1,8 @@
+name: Hidden Lake Service (HLS)
+desc: anonymizes traffic using the QB-problem
+args: |
+  [ -h, --help    ] - print information about service
+  [ -v, --version ] - print version of service
+  [ -p, --path    ] - set path to config, database files
+  [ -n, --network ] - set network key for connections
+  [ -t, --threads ] - set num of parallel functions to calculate PoW

cmd/hls/main.go

@@ -12,6 +12,14 @@ import (
 	"github.com/number571/hidden-lake/build"
 	"github.com/number571/hidden-lake/internal/service/pkg/app"
 	"github.com/number571/hidden-lake/internal/utils/flag"
+	"github.com/number571/hidden-lake/internal/utils/help"
+
+	_ "embed"
+)
+
+var (
+	//go:embed help.yml
+	gHelpYaml []byte
 )
 
 func main() {
@@ -23,16 +31,7 @@ func main() {
 	}
 
 	if flag.GetBoolFlagValue(args, []string{"h", "help"}) {
-		fmt.Print(
-			"Hidden Lake Service (HLS)\n" +
-				"Description: anonymizes traffic using the QB-problem\n" +
-				"Arguments:\n" +
-				"[ -h, --help    ] - print information about service\n" +
-				"[ -v, --version ] - print version of service\n" +
-				"[ -p, --path    ] - set path to config, database files\n" +
-				"[ -n, --network ] - set network key for connections\n" +
-				"[ -t, --threads ] - set num of parallel functions to calculate PoW\n",
-		)
+		help.Println(gHelpYaml)
 		return
 	}
 

cmd/hlt/help.yml

@@ -0,0 +1,7 @@
+name: Hidden Lake Traffic (HLT)
+desc: retransmits and saves encrypted traffic
+args: |
+  [ -h, --help    ] - print information about service
+  [ -v, --version ] - print version of service
+  [ -p, --path    ] - set path to config, database files
+  [ -n, --network ] - set network key for connections

cmd/hlt/main.go

@@ -12,6 +12,14 @@ import (
 	"github.com/number571/hidden-lake/build"
 	"github.com/number571/hidden-lake/internal/helpers/traffic/pkg/app"
 	"github.com/number571/hidden-lake/internal/utils/flag"
+	"github.com/number571/hidden-lake/internal/utils/help"
+
+	_ "embed"
+)
+
+var (
+	//go:embed help.yml
+	gHelpYaml []byte
 )
 
 func main() {
@@ -23,15 +31,7 @@ func main() {
 	}
 
 	if flag.GetBoolFlagValue(args, []string{"h", "help"}) {
-		fmt.Print(
-			"Hidden Lake Traffic (HLT)\n" +
-				"Description: retransmits and saves encrypted traffic\n" +
-				"Arguments:\n" +
-				"[ -h, --help    ] - print information about service\n" +
-				"[ -v, --version ] - print version of service\n" +
-				"[ -p, --path    ] - set path to config, database files\n" +
-				"[ -n, --network ] - set network key for connections\n",
-		)
+		help.Println(gHelpYaml)
 		return
 	}