1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
|
# ``ArgumentParser/ParsableCommand``
`ParsableCommand` types are the basic building blocks for command-line tools built using `ArgumentParser`. To create a command, declare properties using the `@Argument`, `@Option`, and `@Flag` property wrappers, or include groups of options with `@OptionGroup`. Finally, implement your command's functionality in the ``run()-7p2fr`` method.
```swift
@main
struct Repeat: ParsableCommand {
@Argument(help: "The phrase to repeat.")
var phrase: String
@Option(help: "The number of times to repeat 'phrase'.")
var count: Int? = nil
mutating func run() throws {
let repeatCount = count ?? 2
for _ in 0..<repeatCount {
print(phrase)
}
}
}
```
> Note: The Swift compiler uses either the type marked with `@main` or a `main.swift` file as the entry point for an executable program. You can use either one, but not both — rename your `main.swift` file to the name of the command when you add `@main`.
## Topics
### Essentials
- <doc:CommandsAndSubcommands>
- <doc:CustomizingCommandHelp>
### Implementing a Command's Behavior
- ``run()-7p2fr``
- ``ParsableArguments/validate()-5r0ge``
### Customizing a Command
- ``configuration-35km1``
- ``CommandConfiguration``
### Generating Help Text
- ``helpMessage(for:includeHidden:columns:)``
### Starting the Program
- ``main()``
- ``main(_:)``
### Manually Parsing Input
- ``parseAsRoot(_:)``
|
