summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/docs/troubleshooting.md46
-rw-r--r--docs/sidebars.js1
2 files changed, 47 insertions, 0 deletions
diff --git a/docs/docs/troubleshooting.md b/docs/docs/troubleshooting.md
new file mode 100644
index 00000000..57b465e8
--- /dev/null
+++ b/docs/docs/troubleshooting.md
@@ -0,0 +1,46 @@
+# Troubleshooting
+
+The Continue VS Code extension is currently in beta. It will attempt to start the Continue Python server locally for you, but sometimes this will fail, causing the "Starting Continue server..." not to disappear, or other hangups. While we are working on fixes to all of these problems, there are a few things you can do to temporarily troubleshoot:
+
+## For Windows Users
+
+In order to activate the Continue virtual environment, you must enable running scripts in PowerShell. In this case, the following error will appear in the console:
+
+```
+A Python virtual enviroment cannot be activated because running scripts is disabled for this user. In order to use Continue, please enable signed scripts to run with this command in PowerShell: `Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser`, reload VS Code, and then try again.
+```
+
+Please open PowerShell, run the command (`Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser`), and reload VS Code.
+
+## For Linux Users
+
+Linux does not come pre-installed with `python3-venv`, which is needed for Continue to donwload dependencies and run the local server. If you see a related error, you can solve by:
+
+1. Checking your Python version with `python3 --version`
+2. Update `apt-get` with `apt-get update`
+3. Install the correct version of `python3-venv` by running `apt-get install python3.X-venv` (replacing `3.X` with your Python version. For example, if you saw "Python 3.11.4", this should be "3.11")
+4. Reload VS Code
+
+## Reload VS Code
+
+Open the command palette with cmd+shift+p, then type "Reload Window" and select it. This will give Continue another chance to start the server.
+
+## Kill the existing server
+
+If the above doesn't work, you can try to kill the server manually before reloading.
+
+1. Open any terminal
+2. Enter `lsof -i :65432 | grep "(LISTEN)" | awk '{print $2}' | xargs kill -9` to kill the server running on port 65432.
+3. Restart VS Code, and Continue will attempt to start a fresh server.
+
+## Manually install Python requirements
+
+Open any terminal and run `cd ~/.continue/server` to enter the Continue server directory, then `pip3 install -r requirements.txt` to install the requirements. Restarting VS Code should now correctly start the server.
+
+## Run the server manually
+
+If none of these work, you can start the server yourself as is explained here: [Running the Continue server manually](https://continue.dev/docs/how-continue-works)
+
+## Still having trouble?
+
+Create a GitHub issue [here](https://github.com/continuedev/continue/issues/new?assignees=&labels=bug&projects=&template=bug-report-%F0%9F%90%9B.md&title=), leaving the details of your problem, and we'll be able to more quickly help you out.
diff --git a/docs/sidebars.js b/docs/sidebars.js
index 45befd2c..3f9aeba6 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -21,6 +21,7 @@ const sidebars = {
"customization",
"collecting-data",
"telemetry",
+ "troubleshooting",
],
};