summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNate Sesti <sestinj@gmail.com>2023-09-13 12:07:44 -0700
committerNate Sesti <sestinj@gmail.com>2023-09-13 12:07:44 -0700
commit1bb877f3183d53b21eab432fd403c1bba69adac7 (patch)
tree488249c31ddc9ff9a62a1a8fe06fbaef33f1d958
parent0940d756dec3b98071ae5e5a12966e02420b3cd2 (diff)
downloadsncontinue-1bb877f3183d53b21eab432fd403c1bba69adac7.tar.gz
sncontinue-1bb877f3183d53b21eab432fd403c1bba69adac7.tar.bz2
sncontinue-1bb877f3183d53b21eab432fd403c1bba69adac7.zip
docs: :memo: updated setup docs
-rw-r--r--build.cmd22
-rw-r--r--docs/docs/quickstart.md2
-rw-r--r--docs/docs/troubleshooting.md15
-rw-r--r--docs/docs/walkthroughs/manually-run-continue.md48
-rw-r--r--docs/docs/walkthroughs/running-continue-without-internet.md10
-rw-r--r--docs/sidebars.js6
6 files changed, 89 insertions, 14 deletions
diff --git a/build.cmd b/build.cmd
new file mode 100644
index 00000000..92cb9cb7
--- /dev/null
+++ b/build.cmd
@@ -0,0 +1,22 @@
+@echo off
+
+REM 1. Remove unwanted stuff
+rmdir /s /q build
+rmdir /s /q env
+rmdir /s /q dist
+rmdir /s /q continuedev\.venv
+
+REM 2. Create a new virtual environment and activate it
+python -m venv env
+call env\Scripts\activate
+
+REM 3. Install the required packages
+pip install -r continuedev\requirements.txt
+
+pip install pyinstaller
+
+REM 4. Call PyInstaller from within the virtual environment
+env\Scripts\pyinstaller run.spec
+
+REM 5. Deactivate the virtual environment
+call env\Scripts\deactivate.bat
diff --git a/docs/docs/quickstart.md b/docs/docs/quickstart.md
index af2cd29d..77037b3d 100644
--- a/docs/docs/quickstart.md
+++ b/docs/docs/quickstart.md
@@ -7,3 +7,5 @@
3. Once you do this, you will see the Continue logo show up on the left side bar. If you click it, then the Continue extension will then open up:
![vscode-install](/img/continue-screenshot.png)
+
+4. If you have any problems, see the [troubleshooting guide](./troubleshooting.md) or ask for help in [our Discord](https://discord.gg/NWtdYexhMs).
diff --git a/docs/docs/troubleshooting.md b/docs/docs/troubleshooting.md
index 46845c55..73969ccb 100644
--- a/docs/docs/troubleshooting.md
+++ b/docs/docs/troubleshooting.md
@@ -20,20 +20,9 @@ To get a completely fresh install of Continue, you can delete the `~/.continue`
## 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)
+If none of these work, you can start the server yourself as is explained here: [Running the Continue server manually](./walkthroughs/manually-run-continue.md).
-## Manually download the server binary
-
-Continue runs a Python server locally on your machine, but packages it as a binary using pyinstaller to avoid dependency issues. The corresponding binary for your operating system is downloaded when you first install the extension, but if you are in an air-gapped environment, or are otherwise having trouble setting up, you can manually download the binary from our S3 bucket. These are the download links for each OS:
-
-- [MacOS (Intel)](https://continue-server-binaries.s3.us-west-1.amazonaws.com/mac/run)
-- [MacOS (Apple Silicon)](https://continue-server-binaries.s3.us-west-1.amazonaws.com/apple-silicon/run)
-- [Windows](https://continue-server-binaries.s3.us-west-1.amazonaws.com/windows/run.exe)
-- [Linux](https://continue-server-binaries.s3.us-west-1.amazonaws.com/linux/run)
-
-Once downloaded, start the binary by running `./run` (MacOS/Linux) or `./run.exe` (Windows) in the directory where you downloaded it. You should see that it begins listening on port 65432.
-
-> Important: Continue checks to see if an old version of the binary is running. If so, it will kill the process. To avoid this, you should update the contents of `~/.continue/server/server_version.txt` to match your current Continue extension version (e.g. "0.0.1"). This will prevent the extension from killing the server you just started. Once this is done, you can reload the VS Code window and Continue should connect.
+This may be necessary if you have a firewall blocking the server from downloading, are on an air-gapped computer, or are on an OS where the server binary fails to run (e.g. RHEL8).
## Check the server logs
diff --git a/docs/docs/walkthroughs/manually-run-continue.md b/docs/docs/walkthroughs/manually-run-continue.md
new file mode 100644
index 00000000..26b8e07e
--- /dev/null
+++ b/docs/docs/walkthroughs/manually-run-continue.md
@@ -0,0 +1,48 @@
+# Manually Run Continue
+
+You might want to run Continue manually if
+
+(a) a firewall, VPN, or other issue is stopping Continue from automatically downloading the server binary,
+
+(b) you are on an OS where the binary fails to run (e.g. RHEL8),
+
+(c) you are using an air-gapped computer,
+
+(d) you want to self-host Continue, or
+
+(e) you want to run from source while developing / modifying Continue's code.
+
+In all cases, you should go to VS Code settings, search "continue" and check the box that says "Manually Running Server". This will stop Continue from trying to kill and redownload the server binary.
+
+Next, you'll just need to start a server on your own, and then reload the VS Code window. Below are the 4 ways you can start a server.
+
+## (Recommended) Use the `continuedev` PyPI package
+
+The easiest way to run Continue is to
+
+1. Download the `continuedev` PyPI package by running `pip install continuedev`
+2. Start the server by running `python -m continuedev` in your terminal
+
+## Download the server binary
+
+If you'd like to use a pre-built binary, you can download manually from our S3 bucket. These are the download links for each OS:
+
+- [MacOS (Intel)](https://s3.continue.dev/mac/run)
+- [MacOS (Apple Silicon)](https://s3.continue.dev/apple-silicon/run)
+- [Windows](https://s3.continue.dev/windows/run.exe)
+- [Linux](https://s3.continue.dev/linux/run)
+
+Once downloaded, start the binary by running `./run` (MacOS/Linux) or `./run.exe` (Windows) in the directory where you downloaded it. You should see that it begins listening on port 65432.
+
+## Build the server binary from source
+
+If you don't want to use the PyPI package, but need a version of Continue that works on an OS not listed above, then you can build the server binary from source.
+
+1. Clone the [Continue repo](https://github.com/continuedev/continue)
+2. Change directories into the repo: `cd continue`
+3. Run the build script: `sh build.sh` (or `sh buildm1.sh` if building for an M1 Mac, or `build.cmd` if on Windows without WSL)
+4. Now that the binary is outputted in the `./dist` folder, start the server by running `./dist/run`. You should see that it begins listening on port 65432.
+
+## Run the server from source
+
+If you want to develop or modify Continue's code, you can run the server from source. To do this, follow the instructions on development setup in our [CONTRIBUTING.md](https://github.com/continuedev/continue/blob/main/CONTRIBUTING.md#environment-setup).
diff --git a/docs/docs/walkthroughs/running-continue-without-internet.md b/docs/docs/walkthroughs/running-continue-without-internet.md
new file mode 100644
index 00000000..f9d9799d
--- /dev/null
+++ b/docs/docs/walkthroughs/running-continue-without-internet.md
@@ -0,0 +1,10 @@
+# Running Continue without Internet
+
+Continue can be run even on an air-gapped computer if you use a local model. You'll have to make a few adjustments for this to work.
+
+1. Download the latest .vsix file from the [Open VSX Registry](https://open-vsx.org/extension/Continue/continue) and [install it to VS Code](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix).
+2. In VS Code settings, search "continue" and check the box that says "Manually Running Server". This will stop Continue from trying to kill and redownload the server binary.
+3. Follow instructions to [run Continue manually](./manually-run-continue.md).
+4. Open `~/.continue/config.py` and set `allow_anonymous_telemetry=False`. This will stop Continue from attempting requests to PostHog.
+5. Also in `config.py`, set the default model to a local model. You can read about the available options [here](../customization/models.md).
+6. Restart VS Code for changes to `config.py` to take effect.
diff --git a/docs/sidebars.js b/docs/sidebars.js
index a8ca0a12..b6c7b899 100644
--- a/docs/sidebars.js
+++ b/docs/sidebars.js
@@ -36,7 +36,11 @@ const sidebars = {
label: "🚶 Walkthroughs",
collapsible: true,
collapsed: true,
- items: ["walkthroughs/codellama"],
+ items: [
+ "walkthroughs/codellama",
+ "walkthroughs/manually-run-continue",
+ "walkthroughs/running-continue-without-internet",
+ ],
},
"development-data",
"telemetry",