aotuai / brainframe-cli

🧠🖼️👩🏽‍💻 A CLI that makes installing and managing a BrainFrame server easy!

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Consider allowing shorthand for commands

velovix opened this issue · comments

Git allows users to only type part of a command if the rest of it can be unambiguously guessed. In the BrainFrame CLI this would mean that the user could type brainframe c up instead of brainframe compose up because "compose" is the only command that starts with a "c".

Pros

  • It's a relatively standard feature
  • It lets users type less

Cons

  • Additional complexity when parsing arguments
  • When we add additional commands, it could break peoples' workflows by not allowing them to use their preferred shorthand anymore

@apockill @BryceBeagle What do you think? I'm mildly in favor, mostly because compose commands can get fairly long right now.

Could we add a check to see if the command is being run in a non-interactive shell, and throw a warning if a shorthand command is used? This could help prevent tooling/scripts from using the shorthand commands.

Yeah, I think we could do that!

I'm down to clown. I already alias all my usages to bfc for brainframe compose so shorter commands are definitely a want from my end.