Auto-complete soda CLI commands

[mathissedestrooper]

Is your feature request related to a problem? Please describe.
I'm constantly trying to auto-complete soda commands by pressing "tab".

Describe the solution you'd like
Auto-complete soda-commands.

Additional context
This is definitely not a crucial feature request but could be a nice-to-have in the future 😃

Soda SQL Version:
Soda CLI version 2.0.0b21

[milanaleksic]

If you are using bash this should work:
eval "$(_SODA_COMPLETE=source_bash soda)"

Can you try it out?

Reference: https://click.palletsprojects.com/en/7.x/bashcomplete/

[mathissedestrooper]

Hi @milanaleksic

I'm using zsh. I tried adding eval "$(_SODA_COMPLETE=source_zsh soda) to my ~/.zshrc file as described here: https://click.palletsprojects.com/en/7.x/bashcomplete/ but no luck so far. Might that be because I'm running soda-sql in a virtual python environment?

[milanaleksic]

Correct.

Soda is not currently meant to be a globally installed CLI toolkit, but to keep it contained in a virtual environment. You might want to propose to create binary packages later on which we can install independently from the other tools in the target computer by having separate dependencies (maybe even separate python?) and then you can add that line in your shell config.

For now the only thing I can say that your eval command should work while you are in a virtual environment, since the soda command needs to be available to provide the shell completion shell functions.

[vijaykiran]

This works as advertised, Using peen and activating the proper venv with soda command.

soda-sql on  main via 🐍 v3.8.5 (soda-sql-main)
❯ eval "$(_SODA_COMPLETE=source_zsh soda)"
soda-sql on  main via 🐍 v3.8.5 (soda-sql-main)
❯ soda <TAB>
analyze  -- Analyzes tables in the warehouse and creates...
create   -- Creates a new warehouse.yml file and prepares...
scan     -- Computes all measurements and runs all tests...

I don't think there is more we can do, because the user can configure it themselves.

[mathissedestrooper]

Works indeed! Great thx :)

[milanaleksic]

We could document it though for the users so they know it is supported?

[mathissedestrooper]

@milanaleksic makes sense. Although it's fairly limited now. It only works on the commands and not on the optional parameters I think