sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2024-11-23 23:48:56 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 16
khoj/docs/windows_install.md
sabaimran 1610d2ebd9
📝 Add a documentation base for Khoj! (#333) 
* Add docs for more organized, accessible information detailing Khoj setup
* Delete duplicated files
* Add a coverpage without enabling it. Add logo and theme
* Remove obsidian README.md
* Add plausible script to index.html via docsify
2023-07-20 22:34:25 -07:00

1.5 KiB
Raw Blame History

Windows Installation

These steps can be used to setup Khoj on a clean, new Windows 11 machine. It has been tested on a Windows VM

Prerequisites

  1. Ensure you have Visual Studio C++ Build tools installed. You can download it from Microsoft here. At the minimum, you should have the following configuration: Screenshot 2023-07-12 at 3 56 25 PM
  2. Ensure you have Python installed. You can check by running python --version. If you don't, install the latest version from here.
    • Ensure you have pip installed: py -m ensurepip --upgrade.

Quick start

  1. Open a PowerShell terminal.
  2. Run pip install khoj-assistant
  3. Start Khoj with khoj

Installation in a Virtual Environment

Use this if you want to install with a virtual environment. This will make it much easier to manage your dependencies. You can read more about virtual environments here.

  1. Open a PowerShell terminal with the Run as Administrator privileges.
  2. Create a virtual environment: mkdir khoj && cd khoj && py -m venv .venv
  3. Activate the virtual environment: .\.venv\Scripts\activate. If you get a permissions error, then run Set-ExecutionPolicy -ExecutionPolicy RemoteSigned.
  4. Run pip install khoj-assistant
  5. Start Khoj with khoj