This module is a fork from https://github.com/docopt/docopt.fs/ but with strong ordering. The strong ordering enables you to have a nice CLI on your script or to write your own fake 5 and above modules with a CLI.
#r "paket: nuget Fake.Core.CommandLineParsing //" open Fake.Core let cli = """ usage: prog [options] options: -a Add -r Remote -m <msg> Message """ // retrieve the fake 5 and above context information let ctx = Context.forceFakeContext () // get the arguments let args = ctx.Arguments let parser = Docopt(cli) let parsedArguments = parser.Parse(args) if DocoptResult.hasFlag "-a" parsedArguments then printfn "Got -a" match DocoptResult.tryGetArgument "-m" results with | None -> printfn "Printing generic message" | Some arg -> printfn "%s" arg
Note the following links are permalinks to old commits. They are intended only as examples. You are encouraged to look at the current version too, because it's likely to have been updated.
Or the target module:
You can also take a look at the test-suite:
The parser doesn't differentiate between arguments with and without
-with regards to ordering. They are subject to the same rules as other arguments. The only exception is when defining multiple arguments like
[-a -b -c], then the ordering of the group doesn't matter. (So in other words: If a group
only has options then the order doesn't matter)
- Uniquely identifiable prefixes like
--fsiaare not supported
- We return the arguments in the user given order in the result map (difference to
We parse arguments starting with
-as positional arguments. For example consider:
bash usage: prog (NAME | --foo NAME) options: --foo
Note that --foo has no argument because it was not specified in the options section!
In this scenario
prog --foo 10 is parsed as
NAME argument because that is the only option. However
prog --foo=10 is parsed as
NAME argument without any
--foo option. Usually to prefer
--foo you should put it first in the usage string:
However, in this particular case it doesn't make any difference (as the options section is missing to indicate that
--foo has an argument).
is not inherited for all items, only for the group. To have all items optional use
on every item. For example
usage: prog [go go]means to have either two
goor none. A single one is not allowed.
We do not merge external "options" in the usage string with
[options]. For example:
usage: prog [options] [-a] options: -a -b
-ais actually allowed twice.