Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

UsageAst

Union Cases

Union CaseDescription
Ano(title,o')
Signature: string * SafeOptions

Matches an option annotation [options]
Arg(name')
Signature: string

Named/Positional argument
Cmd(cmd')
Signature: string

Fixed command, like "push" in "git push"
Ell(ast')
Signature: UsageAst

Marks that the given item can be given multiple times
Eps
Signature:

matches nothing?
Lop(o')
Signature: SafeOption

long option
Req(ast')
Signature: UsageAst

Requires the given item
Sdh
Signature:

matches the stdin [-]
Seq(asts')
Signature: UsageAst list

Sequence of items, if the items are only options then order is ignored.
Sop(o')
Signature: SafeOptions

Short options
Sqb(ast')
Signature: UsageAst

Marks the given item as optional
Xor(l',r')
Signature: UsageAst * UsageAst

Either the one or the other
XorEmpty
Signature:

Instance members

Instance memberDescription
x.ContainsOnlyOptions
Signature: bool
x.InstanceOfSop
Signature: bool