Commit 99cb6bf2 authored by Philipp Nowinski's avatar Philipp Nowinski

[TASK] add troubleshooting section

parent 80f6874c
......@@ -240,3 +240,23 @@ Execute your custom scripts by calling sgc <scriptName>
```bash
sgc updateInstance
```
# Troubleshooting
## Autocompletion is not working
In order for autocompletion to work, your shell needs to know about the SGC autocompletion file. Depending on your operating system, you will find this under ```/etc/bash_completion.d/sgc``` (Linux), or ```/usr/local/etc/bash_completion.d/sgc``` (macOS). Usually, your shell will automatically read this file. If autocompletion is not working, it is very likely, that for some reason it does not. To fix it, you can simply include it in your ```.bashrc``` file:
```
source /usr/local/etc/bash_completion.d/sgc
[or]
source /etc/bash_completion.d/sgc
```
## I added the code to my ```.bashrc``` file, but autocompletion does still not work
On some macOS installations, bash won't read the ```.bashrc``` file on startup. To fix this, you can source the file inside ```~/.bash_profile```:
```
source ~/.bashrc
```
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment