https://github.com/iffy/nim-argparse

Argument parsing for Nim
https://github.com/iffy/nim-argparse

Last synced: about 2 months ago
JSON representation

Argument parsing for Nim

• Host: GitHub
• URL: https://github.com/iffy/nim-argparse
• Owner: iffy
• License: mit
• Created: 2018-10-10T15:14:58.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-08-16T18:56:53.000Z (4 months ago)
• Last Synced: 2024-08-16T20:12:44.136Z (4 months ago)
• Language: Nim
• Homepage:
• Size: 318 KB
• Stars: 119
• Watchers: 6
• Forks: 8
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-cli-frameworks - nim-argparse
• awesome-nim - argparse - Argument parsing for Nim. (Development Tools / Command-Line Interface Automation)

README

        
# argparse

![tests](https://github.com/iffy/nim-argparse/workflows/tests/badge.svg?branch=master)

[Docs](https://www.iffycan.com/nim-argparse/argparse.html)

Command line argument parsing library.  It generates the parser at compile time so that parsed options have a well-defined type.

# Example

After defining your expected arguments with `newParser(...)`, use:

1. `run(...)` to parse and execute any `run:` blocks you've defined.  This will automatically display help text when `-h`/`--help` is used.

2. `parse(...)` to parse without executing, giving you more control over what happens.

Both procs will parse the process' command line if no arguments are given.

[See the docs for more info](https://www.iffycan.com/nim-argparse/argparse.html)

## run()

```nim

import argparse

var p = newParser:

  flag("-a", "--apple")

  flag("-b", help="Show a banana")

  option("-o", "--output", help="Output to this file")

  command("somecommand"):

    arg("name")

    arg("others", nargs = -1)

    run:

      echo opts.name

      echo opts.others

      echo opts.parentOpts.apple

      echo opts.parentOpts.b

      echo opts.parentOpts.output

      echo opts.parentOpts.output_opt.get()

try:

  p.run(@["--apple", "-o=foo", "somecommand", "myname", "thing1", "thing2"])

except UsageError as e:

  stderr.writeLine getCurrentExceptionMsg()

  quit(1)

```

## parse()

```nim

import argparse

var p = newParser:

  flag("-a", "--apple")

  flag("-b", help="Show a banana")

  option("-o", "--output", help="Output to this file")

  arg("name")

  arg("others", nargs = -1)

try:

  var opts = p.parse(@["--apple", "-o=foo", "hi"])

  assert opts.apple == true

  assert opts.b == false

  assert opts.output == "foo"

  assert opts.name == "hi"

  assert opts.others == @[]

except ShortCircuit as err:

  if err.flag == "argparse_help":

    echo err.help

    quit(1)

except UsageError:

  stderr.writeLine getCurrentExceptionMsg()

  quit(1)

```

# Alternatives

If `argparse` doesn't suit your needs, consider these alternatives:

- 

-