A pure Swift library for creating command-line interfaces.
Note: CommandLine master
requires Xcode 7 / Swift 2.0, and aims to support the latest 2.2-dev snapshot on Linux (although not all tests pass yet). If you're using older versions of Swift, please check out the earlier releases.
CommandLine aims to have a simple and self-explanatory API.
import CommandLine
let cli = CommandLine()
let filePath = StringOption(shortFlag: "f", longFlag: "file", required: true,
helpMessage: "Path to the output file.")
let compress = BoolOption(shortFlag: "c", longFlag: "compress",
helpMessage: "Use data compression.")
let help = BoolOption(shortFlag: "h", longFlag: "help",
helpMessage: "Prints a help message.")
let verbosity = CounterOption(shortFlag: "v", longFlag: "verbose",
helpMessage: "Print verbose messages. Specify multiple times to increase verbosity.")
cli.addOptions(filePath, compress, help, verbosity)
do {
try cli.parse()
} catch {
cli.printUsage(error)
exit(EX_USAGE)
}
print("File path is \(filePath.value!)")
print("Compress is \(compress.value)")
print("Verbosity is \(verbosity.value)")
See Option.swift
for additional Option types.
To use CommandLine in your project, add it to your workspace, then add CommandLine.framework to the Build Phases / Link Binary With Libraries setting of your target.
If you are building a command-line tool and need to embed this and other frameworks to it, follow the steps in http://colemancda.github.io/programming/2015/02/12/embedded-swift-frameworks-osx-command-line-tools/ to link Swift frameworks to your command-line tool.
If you are building a standalone command-line tool, you'll need to add the CommandLine source files directly to your target, because Xcode can't yet build static libraries that contain Swift code.
Usage: example [options]
-f, --file:
Path to the output file.
-c, --compress:
Use data compression.
-h, --help:
Prints a help message.
-v, --verbose:
Print verbose messages. Specify multiple times to increase verbosity.
You can fully customize the usage message by supplying a formatOutput
function. For example, Rainbow provides a handy way to generate colorized output:
import Rainbow
cli.formatOutput = { s, type in
var str: String
switch(type) {
case .Error:
str = s.red.bold
case .OptionFlag:
str = s.green.underline
case .OptionHelp:
str = s.blue
default:
str = s
}
return cli.defaultFormat(str, type: type)
}
These command-lines are equivalent:
$ ./example -c -v -f /path/to/file
$ ./example -cvf /path/to/file
$ ./example -c --verbose --file /path/to/file
$ ./example -cv --file /path/to/file
$ ./example --compress -v --file=/path/to/file
Option processing can be stopped with '--', as in getopt(3).
This will pass negative 42 to the int option, and negative 3.1419 to the float option:
$ ./example2 -i -42 --float -3.1419
Floats will be handled correctly when in a locale that uses an alternate decimal point character:
$ LC_NUMERIC=sv_SE.UTF-8 ./example2 --float 3,1419
enum Operation: String {
case Create = "c"
case Extract = "x"
case List = "l"
case Verify = "v"
}
let cli = CommandLine()
let op = EnumOption<Operation>(shortFlag: "o", longFlag: "operation", required: true,
helpMessage: "File operation - c for create, x for extract, l for list, or v for verify.")
cli.setOptions(op)
do {
try cli.parse()
} catch {
cli.printUsage(error)
exit(EX_USAGE)
}
switch op.value {
case Operation.Create:
// Create file
case Operation.Extract:
// Extract file
// Remainder of cases
}
Note: Enums must be initalizable from a String value.
$ ./example3 -👍 --👻
(please don't actually do this)
Copyright (c) 2014 Ben Gollmer.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.