https://github.com/docopt/docopt.jl
command line arguments parser
https://github.com/docopt/docopt.jl
julia
Last synced: about 1 year ago
JSON representation
command line arguments parser
- Host: GitHub
- URL: https://github.com/docopt/docopt.jl
- Owner: docopt
- License: other
- Created: 2014-03-07T15:14:05.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2023-03-24T09:22:52.000Z (about 3 years ago)
- Last Synced: 2025-06-15T05:03:17.985Z (about 1 year ago)
- Topics: julia
- Language: Julia
- Homepage:
- Size: 99.6 KB
- Stars: 94
- Watchers: 14
- Forks: 21
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# DocOpt.jl
[](https://travis-ci.org/docopt/DocOpt.jl)
**DocOpt.jl** is a port of [**docopt**](http://docopt.org/) written in the [Julia](http://julialang.org/) language.
**docopt** generates a command-line arguments parser from human-readable usage patterns.
You will find how attractive the idea of **docopt** is with the example below:
```julia
doc = """Naval Fate.
Usage:
naval_fate.jl ship new ...
naval_fate.jl ship move [--speed=]
naval_fate.jl ship shoot
naval_fate.jl mine (set|remove) [--moored|--drifting]
naval_fate.jl -h | --help
naval_fate.jl --version
Options:
-h --help Show this screen.
--version Show version.
--speed= Speed in knots [default: 10].
--moored Moored (anchored) mine.
--drifting Drifting mine.
"""
using DocOpt # import docopt function
args = docopt(doc, version=v"2.0.0")
```
The result is:
```
$ julia -qL examples/naval_fate.jl ship new FOO
julia> args
Dict{String,Any} with 15 entries:
"remove" => false
"--help" => false
"" => String["FOO"]
"--drifting" => false
"mine" => false
"move" => false
"--version" => false
"--moored" => false
"" => nothing
"ship" => true
"new" => true
"shoot" => false
"set" => false
"" => nothing
"--speed" => "10"
```
Julia v0.6 is now supported.
## API
The `DocOpt` module exports just one function, `docopt`, which takes multiple
arguments but all of them except the first one are optional.
```julia
docopt(doc::AbstractString, argv=ARGS; help=true, version=nothing, options_first=false, exit_on_error=true)
```
**Arguments**
* `doc` : Description of your command-line interface. (type: `AbstractString`)
* `argv` : Argument vector to be parsed. (type: `String` or `Vector{String}`, default: `ARGS`)
* `help` : Set to `false` to disable automatic help on -h or --help options. (type: `Bool`, default: `true`)
* `version` : If passed, the value will be printed if --version is in `argv`. (any type, but `VersionNumber` is recommended, e.g. v"1.0.2")
* `options_first` : Set to `true` to require options precedes positional arguments, i.e. to forbid options and positional arguments intermix. (type: `Bool`, default: `false`)
* `exit_on_error` : Set to `true` to print the usage and exit when parsing error happens. This option is for unit testing. (type: `Bool`, default: `true`)
`doc` argument is mandatory, `argv` argument is automatically set to command-line arguments, and `help`, `version`, `options_first` and `exit_on_error` are keyword arguments.
**Return**
* parsed arguments : An associative collection, where keys are names of command-line elements such as e.g. "--verbose" and "", and values are the parsed values of those elements. (type: `Dict{String,Any}`)
See for more details about the grammar of the usage pattern.