https://github.com/jodersky/scala-argparse

Pragmatic command line parsing and configuration for Scala apps
https://github.com/jodersky/scala-argparse

cli cli-parser

Last synced: 9 days ago
JSON representation

Pragmatic command line parsing and configuration for Scala apps

• Host: GitHub
• URL: https://github.com/jodersky/scala-argparse
• Owner: jodersky
• License: bsd-3-clause
• Created: 2020-04-23T21:58:25.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-04-03T16:41:28.000Z (over 1 year ago)
• Last Synced: 2024-10-18T06:21:47.120Z (19 days ago)
• Topics: cli, cli-parser
• Language: Scala
• Homepage: https://jodersky.github.io/scala-argparse
• Size: 12.7 MB
• Stars: 13
• Watchers: 4
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# scala-argparse

[![project docs](https://img.shields.io/badge/docs-website-blueviolet)](https://jodersky.github.io/scala-argparse)

[![discord](https://img.shields.io/badge/chat-discord-blue)](https://discord.gg/usj9DC8FDN)

[![project chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://crashbox.zulipchat.com/#narrow/stream/330744-argparse)

[![latest version][scaladex-badge]][scaladex-link]

[![stability: firm](https://img.shields.io/badge/stability-firm-silver)](https://www.crashbox.io/stability.html)

[scaladex-badge]: https://index.scala-lang.org/jodersky/scala-argparse/argparse/latest.svg

[scaladex-link]: https://index.scala-lang.org/jodersky/scala-argparse/argparse

Pragmatic command line parsing for Scala applications.

## Highlights

- Simple interface, inspired by the

  [argparse](https://docs.python.org/3/library/argparse.html) package from

  python.

- Bash completion.

  - Standalone bash completion for a super snappy user experience, even on the

    JVM.

  - Interactive bash completion for the most custom needs.

- Works with Scala 2 and 3, Native and JVM

## Docs

- HTML: look at the [website](https://jodersky.github.io/scala-argparse)

- source (markdown): browse the docs/ folder.

## Building

This project uses [Mill](https://github.com/com-lihaoyi/mill) to build. The

configuration is in the `build.sc` file.

### Developer

- compile main project for all supported versions of scala: `./mill argparse.__.compile`

- run all tests: `./mill __.test`

- run an example:

  - `./mill examples. `

  - e.g. `./mill examples.paramnamed --verbosity 5`

  - note: examples use Scala Native and hence require llvm

- publish main project locally: `./mill argparse.__.publishLocal`

### Maintainer

Look at the scripts in the `ci/` directory.