hurl/docs/spec/options
Ashish Reddy 2346942e7a
Update docs to mention supported time units
2025-10-10 12:21:54 +00:00
..
hurl Update docs to mention supported time units 2025-10-10 12:21:54 +00:00
hurlfmt enhance/hurlfmt: remove depreciated --format option 2024-11-29 22:36:07 +00:00
README.md Fix option connect-timeout help message and documentation. 2024-10-24 09:04:35 +02:00

README.md

Command Line Options

Hurl command line options are described with .option files. These files are used to generate:

  • Rust code to parse this options in hurl/hurlfmt packages
  • Man options

Format all option files

$ bin/spec/options/format.py docs/spec/options/**/*.option

This script insures that all .option files are well formatted.

Generate/Update clap command source file

$ bin/spec/options/generate_source.py docs/spec/options/hurl/*.option > packages/hurl/src/cli/options/commands.rs
$ bin/spec/options/generate_source.py docs/spec/options/hurlfmt/*.option >packages/hurlfmt/src/cli/options/commands.rs

This script generates Rust source file for parsing command line option.

Generate/Update man options

$ bin/spec/options/generate_man.py docs/spec/options/hurl/*.option
$ bin/spec/options/generate_man.py docs/spec/options/hurlfmt/*.option

This script generates (part of) man file for hurl / hurlfmt.

A script is provided to run all these commands:

$ bin/spec/options/generate_all.py