[Question] How do I mark a command as deprecated?

I see from https://github.com/yargs/yargs/pull/1559 that it is now possible to mark options as deprecated. I have attempted to use this functionality at a higher level to mark an entire command as deprecated, but it does not work. Is this feature not yet implemented or am I missing something?

This is the usage I am attempting:

module.exports = {
  command: 'old [path]',
  deprecated: '[deprecated: use new instead]'
};

[ryandberger]

Would love to see a warning emitted when the command is used. I think that would be particularly useful for automation processes. For your approach, I personally would lean towards option 2 since I imagine developers would want consistent behavior across their app. I think it would also make option 3 more natural to implement when the time comes. Appreciate your help on this!

[ryandberger]

Yes, I do see the [deprecated] indicator next to command cmd1 when calling --help generally. But when I call cmd1 --help I don’t see the message after the command description which I think is unexpected.