https://github.com/nixosbrasil/climod

Modular generated command line interfaces using the same technology as the NixOS module system.
https://github.com/nixosbrasil/climod

Last synced: about 2 months ago
JSON representation

Modular generated command line interfaces using the same technology as the NixOS module system.

• Host: GitHub
• URL: https://github.com/nixosbrasil/climod
• Owner: nixosbrasil
• Created: 2022-05-29T13:22:40.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-02-26T14:27:41.000Z (over 1 year ago)
• Last Synced: 2024-06-03T03:35:57.657Z (4 months ago)
• Language: Nix
• Size: 34.2 KB
• Stars: 41
• Watchers: 4
• Forks: 6
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# climod

[![built with nix](https://builtwithnix.org/badge.svg)](https://builtwithnix.org)

 Modular generated command line interfaces using the same technology as the NixOS module system.

## Objective

What if you could generate CLI scripts with keyword parsing and environment variables with value validation and so on using a JSON like interface, but turing complete...

Or even generate consistent CLIs for more than one programming language... (WIP, only bash atm).

Maybe integrate in your own repo or automations.

With this library and Nix now you can. See the [example](./example.nix) to get more details about how. If you nix-build it then it should generate a script on ./result that you can play with.

# What works

- Generation of bash scripts

    - Flag parsing

    - Subcommands

    - Prelude (setup code before anything but `set -eu` and shebang)

    - Your payload code just consume environment variables

    - Positional arguments. All input values are flag based so far.

# What doesn't work

    - List of things. Each flag can only be provided once.