Skip to content

Commit 5ca460a

Browse files
authored
Use multi-line string to clean up help/usage for loopinstall (#1138)
1 parent d4ab451 commit 5ca460a

File tree

1 file changed

+43
-38
lines changed

1 file changed

+43
-38
lines changed

pkg/loop/cmd/loopinstall/main.go

Lines changed: 43 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -92,42 +92,47 @@ func main() {
9292

9393
// printHelp prints usage and help information
9494
func printHelp() {
95-
fmt.Println("Chainlink Plugin Installer")
96-
fmt.Println("\nA tool for installing Chainlink plugins from YAML configuration files.")
97-
fmt.Println("\nUsage:")
98-
fmt.Println(" loopinstall [options] <plugin-config-file> [<plugin-config-file>...]")
99-
fmt.Println("\nOptions:")
100-
fmt.Println(" -h, --help Show this help message")
101-
fmt.Println(" -v, --verbose Enable verbose output")
102-
fmt.Println(" -c, --concurrency <num> Set maximum number of concurrent installations (default: 5)")
103-
fmt.Println(" -s, --sequential Install plugins sequentially (no concurrency)")
104-
fmt.Println(" -o, --output-installation-artifacts <file> Path for installation artifacts JSON file")
105-
fmt.Println(" (optional, no installation artifacts written if not specified)")
106-
fmt.Println("\nExamples:")
107-
fmt.Println(" # Install plugins from the default configuration")
108-
fmt.Println(" loopinstall plugins.default.yaml")
109-
fmt.Println("")
110-
fmt.Println(" # Install plugins with custom installation artifacts filename")
111-
fmt.Println(" loopinstall -o ./installation-artifacts.json plugins.default.yaml")
112-
fmt.Println("")
113-
fmt.Println(" # Install plugins sequentially")
114-
fmt.Println(" loopinstall -s plugins.default.yaml")
115-
fmt.Println("")
116-
fmt.Println(" # Install plugins with environment variable overrides")
117-
fmt.Println(" CL_PLUGIN_GOFLAGS=\"-ldflags='-s'\" loopinstall plugins.default.yaml")
118-
fmt.Println("")
119-
fmt.Println("Environment Variables:")
120-
fmt.Println(" CL_PLUGIN_GOFLAGS Override the goflags option from the configuration")
121-
fmt.Println("")
122-
fmt.Println("Plugin Configuration Format:")
123-
fmt.Println(" defaults:")
124-
fmt.Println(" goflags: \"\" # Default Go build flags")
125-
fmt.Println("")
126-
fmt.Println(" plugins:")
127-
fmt.Println(" plugin-type:")
128-
fmt.Println(" - moduleURI: \"github.com/example/module\"")
129-
fmt.Println(" gitRef: \"v1.0.0\"")
130-
fmt.Println(" installPath: \"./cmd/example\"")
131-
fmt.Println(" libs: [\"/path/to/libs/*.so\"] # Optional library paths (can include glob patterns)")
132-
fmt.Println(" # enabled: false # Optional, defaults to true if omitted")
95+
fmt.Print(`Chainlink Plugin Installer
96+
97+
A tool for installing Chainlink plugins from YAML configuration files.
98+
99+
Usage:
100+
loopinstall [options] <plugin-config-file> [<plugin-config-file>...]
101+
102+
Options:
103+
-h, --help Show this help message
104+
-v, --verbose Enable verbose output
105+
-c, --concurrency <num> Set maximum number of concurrent installations (default: 5)
106+
-s, --sequential Install plugins sequentially (no concurrency)
107+
-o, --output-installation-artifacts <file> Path for installation artifacts JSON file
108+
(optional, no installation artifacts written if not specified)
109+
110+
Examples:
111+
# Install plugins from the default configuration
112+
loopinstall plugins.default.yaml
113+
114+
# Install plugins with custom installation artifacts filename
115+
loopinstall -o ./installation-artifacts.json plugins.default.yaml
116+
117+
# Install plugins sequentially
118+
loopinstall -s plugins.default.yaml
119+
120+
# Install plugins with environment variable overrides
121+
CL_PLUGIN_GOFLAGS="-ldflags='-s'" loopinstall plugins.default.yaml
122+
123+
Environment Variables:
124+
CL_PLUGIN_GOFLAGS Override the goflags option from the configuration
125+
126+
Plugin Configuration Format:
127+
defaults:
128+
goflags: "" # Default Go build flags
129+
130+
plugins:
131+
plugin-type:
132+
- moduleURI: "github.com/example/module"
133+
gitRef: "v1.0.0"
134+
installPath: "./cmd/example"
135+
libs: ["/path/to/libs/*.so"] # Optional library paths (can include glob patterns)
136+
# enabled: false # Optional, defaults to true if omitted
137+
`)
133138
}

0 commit comments

Comments
 (0)