Install Ctrl+Revise
System Requirements:
8GB of VRAM (GPU) or 16GB of RAM (CPU)
Prerequisites
Ollama
If Ollama
is not installed you will be assisted in getting it installed.
You can download the latest release from the Ollama.com website.
MacOS
MacOS users can install Ollama using Homebrew.
1brew install ollama
Arch Linux
Arch Linux users can install Ollama from the official repository.
sudo pacman -S ollama-rocm
sudo pacman -S ollama-nvidia
sudo pacman -S ollama
Connect to Ollama
If you are running ollama on a different machine, you can connect to it by setting the environment variable OLLAMA_HOST
1export OLLAMA_HOST=http://<host-IP>:11434; ctrl_plus_revise
Docker (optional)
If users select to use Docker to run Ollama, Ctrl+Revise will pull the latest Ollama Docker image and manage running it.
The official Ollama Docker image ollama/ollama
is available on Docker Hub.
docker run -d --device /dev/kfd --device /dev/dri -v ollama:/root/.ollama -p 11434:11434 --name ollama --restart=always ollama/ollama:rocm
docker run -d --gpus=all -v ollama:/root/.ollama -p 11434:11434 --restart=always --name ollama ollama/ollama
docker run -d -v ollama:/root/.ollama -p 11434:11434 --restart=always --name ollama ollama/ollama
Xclip or Xsel (Linux only)
Xclip
or Xsel
are used to interact with the clipboard on Linux systems. They are likely to be installed on your system already.
sudo pacman -S xclip
or
sudo pacman -S xsel
sudo apt install xclip
or
sudo apt install xsel
sudo dnf instal xclip
or
sudo dnf instal xsel
Run Ctrl+Revise
Use the installer or compile the project from source.
Option 1 (recommended)
Download the latest release from the releases page.
Windows
Run the CtrlPlusRevise-Installer-Window-amd64.exe file and follow the instructions.
Linux
The Linux binary will Launch Ctrl+Revise from any directory it is located in.
1chmod +x ctrl_plus_revise-linux-amd64
The tar file includes a Makefile designed to manage the installation process of the Ctrl+Revise application. It includes targets for user-install (no sudo required), system install, and uninstall.
Targets The following targets are available in the Makefile:
1tar -xvf Ctrl+Revise.tar.xz # Extracts the tar file.
2make install # Installs the application in the system's default location.
3make uninstall # Uninstalls the application from the system.
4make user-install # Installs the application in the user's local directory (~/.local/).
5make user-uninstall # Uninstalls the application from the user's local directory.
MacOS
No builds at this time, MacBook screen is currently broke. Follow the build from source instructions.
Option 2 (build from source)
This option lets you get the latest changes. First things first, ensure you have go
installed on your machine.
Windows
Please follow the Getting Started guide from the Fyne documentation here to setup MSYS2 and compile from within the MingW-w64 window.
MacOS
Set up the Xcode command line tools by opening a Terminal window and typing the following:
xcode-select --install
Linux
Find the list of dependencies for your distro in the Fyne documentation here
Compile
To start the project run the following command:
1git clone https://github.com/bahelit/ctrl_plus_revise.git
2cd ctrl_plus_revise
3go run .