Background

I am designing a CLI for a container build tool I am making. It uses Gentoo’s Portage behind the scenes

Question

I want to give the user the ability to specify a custom package repository. The repository must have a name, URI and sync type.

custom_repo: {
    uri: 'https://...',
    name: 'custom',
    sync_type: 'git',
}

How do I have the user represent this in the CLI? keep in mind, this is not the main input and is optional.

One way is to make this only provide-able via a config file using JSON or another structured data representation. But I want to see if theres a good way to do it in the CLI

What I am thinking of: command --custom-repo uri='https://...',name=custom,sync_type=git --custom-repo ... [main input]

Is this the best way of doing this?

  • key@lemmy.keychat.org
    link
    fedilink
    English
    arrow-up
    14
    arrow-down
    1
    ·
    9 months ago

    If the json payload is small with finite keys you can support separate args for those keys. If you really need arbitrary json what you have described is fairly reasonable as a shorthand, similar to AWS CLI shorthand.

    Honestly passing optional/advanced args as json via CLI isn’t usually too bad since you can quote it with single quotes.