feat: Add cli_shortcuts to CLI settings

[karta9821]

It addresses to #623

Selected Reviewer: @dmontagu

[karta9821]

@maxnoe Please verify if it is okay

[hramezani]

@kschwab do you have time to take a look here?

[maxnoe]

Thanks for the quick implementation, I played around with the branch here and it works as I would expect!

Can't comment too much about the code itself.

[karta9821]

please review

[hramezani]

I am waiting for @kschwab for a review, as he implemented most of the CLI settings source code.

[kschwab]

Thanks @karta9821 and @maxnoe for the PR. I am back from vacation. The only two items I see are:

• Documentation needs to be added.
• I would simplify and support multiple aliases, similar to how pydantic AliasChoices works. ie, Map[str, str | list[str]], where key should be the target field, and values are the aliases.

The only real concern I have is confusion between cli_alias and pydantic alias. Is it possible to give the config option a different name? @hramezani do you have thoughts here?

Other than those items, everything else looks good.

[hramezani]

Thanks @kschwab for checking the PR

The only real concern I have is confusion between cli_alias and pydantic alias. Is it possible to give the config option a different name? @hramezani do you have thoughts here?

Agree, Do you have a suggestion for the config name?

@karta9821 Please address the points mentioned by @kschwab. Then we can merge the PR.

[karta9821]

Thanks @kschwab for checking the PR

The only real concern I have is confusion between cli_alias and pydantic alias. Is it possible to give the config option a different name? @hramezani do you have thoughts here?

Agree, Do you have a suggestion for the config name?

@karta9821 Please address the points mentioned by @kschwab. Then we can merge the PR.

Sure, I can adjust the code :)

How about cli_shortcuts

[hramezani]

Thanks @kschwab for checking the PR

The only real concern I have is confusion between cli_alias and pydantic alias. Is it possible to give the config option a different name? @hramezani do you have thoughts here?

Agree, Do you have a suggestion for the config name?
@karta9821 Please address the points mentioned by @kschwab. Then we can merge the PR.

Sure, I can adjust the code :)

How about cli_shortcuts

Looks good to me. what do you think @kschwab

[kschwab]

@hramezani @karta9821 yes, cli_shortcuts sounds good to me as well.

[karta9821]

Fixed

[hramezani]

@karta9821 Thanks for the update. please add the documentation for it

[hyperlint-ai]

PR Change Summary

Added support for CLI shortcuts in settings configuration, allowing users to define alternative argument names for command-line interface options.

• Introduced cli_shortcuts option in SettingsConfigDict for defining alternative CLI argument names.
• Provided examples for both flat and nested settings configurations using CLI shortcuts.
• Documented behavior for shortcut collisions and precedence in settings.

Modified Files

• docs/index.md

---

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

[karta9821]

Added

[hramezani]

Thanks @karta9821 for the quick update.

@kschwab please take a final look when you have time.

[kschwab]

Hey @karta9821 thanks for the changes! It's a great addition, looks good to me.

[hramezani]

Thanks all