Installation Guide

Requirements¶

Python 3.7+

Installation & Usage¶

pip install ubiops-cli

Then use the package like this:

ubiops --version

Shell completion¶

Optionally enable shell completion for your shell of choice.

Run the command below for your shell of choice to enable shell completion for the current shell session. Add the command to your ~/.bashrc, ~/.zshrc or ~/.config/fish/config.fish if you want to make it persistent.

For Bash, add the following line to your ~/.bashrc:
```
. <(ubiops complete bash)
```
For Zsh, add the following line to your ~/.zshrc:
```
. <(ubiops complete zsh)
```
For Fish, add the following line to your ~/.config/fish/config.fish:
```
ubiops complete fish | .
```

Restart your shell for the change to take effect.

Please, be aware that if you run the ubiops-cli in a virtual environment, you should only enable shell completion after activating the virtual environment, or write the content to a file on your system such that it can be found without the virtual environment being activated. E.g. for Bash:

ubiops complete bash > ~/.ubiops-complete.bash

And then add to your ~/.bashrc:

. ~/.ubiops-complete.bash

Restart your shell for the change to take effect.

Troubleshooting¶

Command not found¶

If you successfully installed ubiops-cli but ubiops --version gives the following error: ubiops: command not found, you are likely missing the directory in you PATH variable where PIP installs scripts. You could solve this by adding the directory to your PATH variable. Please, visit https://packaging.python.org/tutorials/installing-packages/#installing-to-the-user-site for more information.

Linux and macOS: ~/.local/bin
Windows: something like C:\Users\Username\AppData\Roaming\Python36\Scripts