ℹ️ Note: On Linux, sometimes pip installs executables into a custom directory; in these cases, it’s necessary to add $HOME/.local/bin to your path in your setup script – i.e. $HOME/.bashrc, or $HOME/.bash_profile (if you are using zsh then ~/.zprofile or ~/.zshrc)
Now, configure the .netrc file to provide the login information required to access a Qorus remote server. For a Qorus server located at https://localhost:8011 and using the Qorus user adm, you should have:
.netrc files are usually placed in the home directory; therefore, write the above contents to a file and save it at:
On Linux and Mac machines:
A few of the commands possible with qorus-remote:
The complete command list is available in our qorus-remote repository
It’s recommended to create aliases for each of the commands, like:
On Windows Command Prompt
DOSKEY oload=qorus-remote-commands %USERPROFILE%\qorus\netrc-qorus-local oload $*DOSKEY qctl=qorus-remote-commands %USERPROFILE%\qorus\netrc-qorus-local qctl $*DOSKEY qrest=qorus-remote-commands %USERPROFILE%\qorus\netrc-qorus-local qrest $*DOSKEY qdp=qorus-remote-commands %USERPROFILE%\qorus\netrc-qorus-local qdp $*alias oload='qorus-remote-commands ~/.netrc-qorus-local oload $*'alias qctl='qorus-remote-commands ~/.netrc-qorus-local qctl $*'alias qrest='qorus-remote-commands ~/.netrc-qorus-local qrest $*'alias qdp='qorus-remote-commands ~/.netrc-qorus-local qdp $*'and so on…
After setting aliases, you can test the python client (qorus-remote) by:
qctl ps – get a list of cluster processesqctl threads qorus-core – get a list of thread stacks for the qorus-core processoload -Ls – lists the services installed in the databaseqrest system/instance-key – returns the system instance key name from the REST API (configured in $OMQ_DIR/etc/options – change requires a restart)
Note: $OMQ_DIR refers to the /opt/qorus on the Docker container. On all hosts using Docker Compose to run Qorus, this is (docker compose file directory)/omq/user directory; where docker compose file directory is the directory from which you ran the docker-compose up -d command earlier.
