README
¶
cl
About
cl is a package for Go to parse command line arguments. It is published on https://codeberg.org/vbsw/cl and https://github.com/vbsw/cl.
Copyright
Copyright 2025, Vitali Baumtrok (vbsw@mailbox.org).
cl is distributed under the Boost Software License, version 1.0. (See accompanying file LICENSE or copy at http://www.boost.org/LICENSE_1_0.txt)
cl is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Boost Software License for more details.
Usage
Example A
package main
import (
"fmt"
"codeberg.org/vbsw/cl"
)
func main() {
clArgs := cl.NewCLArgs()
if clArgs.Argument("--help", "-h").Available() {
fmt.Println("USAGE")
fmt.Println(" --help prints help")
fmt.Println(" --version prints version")
} else if clArgs.Argument("--version", "-v").Available() {
fmt.Println("version 1.0.0")
} else {
restArgs := clArgs.Rest()
if restArgs.Count() == 1 {
fmt.Printf("ERROR unknown parameter \"%s\"\n", restArgs.Params[0])
} else if restArgs.Count() > 1 {
fmt.Println("ERROR too many arguments")
}
}
}
Example B
package main
import (
"fmt"
"codeberg.org/vbsw/cl"
)
func main() {
start := "0"
end := "0"
clArgs := cl.NewCLArgs()
delimiter := []string{"="};
startArg := clArgs.ArgumentByDelimiter(delimiter, "start")
endArg := clArgs.ArgumentByDelimiter(delimiter, "end")
if startArg.Available() {
start = startArg.Values[0]
end = start
}
if endArg.Available() {
end = endArg.Values[0]
}
fmt.Println("processing from", start, "to", end)
}
References
Documentation
¶
Overview ¶
Package cl parses command line arguments.
Index ¶
- type Arguments
- func (clArgs *Arguments) Argument(argVariants ...string) *Result
- func (clArgs *Arguments) ArgumentByDelimiter(delimiter []string, argVariants ...string) *Result
- func (clArgs *Arguments) Available() bool
- func (clArgs *Arguments) Count() int
- func (clArgs *Arguments) InitMeta()
- func (clArgs *Arguments) Rest() *Result
- type Result
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Arguments ¶
Arguments holds command line arguments.
func NewCLArgs ¶
func NewCLArgs() *Arguments
NewCLArgs creates and returns a new instance of Arguments. Arguments have all command line arguments except the first one, which is the program name.
func (*Arguments) ArgumentByDelimiter ¶
ArgumentByDelimiter returns matches of different argument variations splitted by delimiter. First part of the split goes in Arguments.Params, the second in Arguments.Values. Space (" ") as delimiter does not split, but treats two arguments as one.
Source Files