Request: preserving CLI flags in generated text file(s)

[jamesbraza]

With https://github.com/peterdemin/pip-compile-multi/tree/v2.6.3, after running pip-compile-multi --backtracking --no-upgrade, currently the output file looks like this:

# SHA1:abc123
#
# This file is autogenerated by pip-compile-multi
# To update, run:
#
#    pip-compile-multi
#
...

Can we add preservation of CLI flags like --backtracking in the autogenerated .txt file(s)?

[peterdemin]

The reason the options are not saved in the .txt file is that you can use many different options to achieve the same result. For example --upgrade, --no-upgrade, or --upgrade-package options.
I recommend using -h, --header option to document the "right" way of running the tool:
https://pip-compile-multi.readthedocs.io/en/latest/features.html#custom-header

[jamesbraza]

I see the --header's purpose, thanks for sharing that 👍 .

That being said, why not just pass the input args nonetheless? There are many ways to pass CLI args yes, but that doesn't mean they can't be copied into the output file.

So if one invoked pip-compile-multi with --no-upgrade, then the file shows pip-compile-multi --no-upgrade.

Fwiw, this behavior exists with pip-compile, where the tool:

• Doesn't propagate defaulted args
• Does propagate non-defaulted args

[peterdemin]

In general, I'm okay with smart_er_ generation of the header comment. Some flags should not be included, though, namely, --upgrade / --no-upgrade, and --upgrade-package. Other flags seem to be stable for the project.
Would you be open to contributing a PR that adds a new CLI flag to enable the flag passthrough?
I prefer this to be optional at first, and we can make this enabled by default in future releases.
I suggest naming the flag as -w, --write-options.

[peterdemin]

Closing due to lack of traction