Windows (WSL 2)

Get up and running with CodeAssist in your Windows (WSL 2) environment.

Overview

This guide explains how to install and run CodeAssist on Windows using the Windows Subsystem for Linux 2 (WSL 2).

Prerequisites

Before installing CodeAssist, make sure you have:

  • Windows 10 or 11 with WSL 2 enabled and running.

  • A Linux distribution installed under WSL 2

  • Administrator privileges on your device

  • A Hugging Face account for authentication

Dependencies

CodeAssist requires the following software components:

Dependency
Purpose
Minimum Version

Runs the isolated CodeAssist container environment

Latest stable

Executes the environment management and web UI Scripts

3.10+

UV

Manages Python dependencies and virtual environments

Latest stable

Docker & Python

Install Docker and Python according to the installation steps for your platform.

UV

To install UV, a lightweight dependency manager used to handle the project's Python environment, use the following command inside your WSL 2 terminal:

curl -LsSf https://astral.sh/uv/install.sh | sh

You can then check if the installation was successful and check the version of UV installed with uv --version.

Installation Steps

  1. Open your WSL 2 terminal (Ubuntu or another distro).

  2. Clone the CodeAssist repository:

git clone https://github.com/gensyn-ai/codeassist.git
cd codeassist

Run CodeAssist

To open CodeAssist, run the following command in your terminal:

uv run run.py

The first run may take several minutes as Docker builds the environment and downloads required components.

Once running, CodeAssist automatically launches in your browser. If it doesn't, visit the following localhost URL and open it manually:

http://localhost:3000

Authentication

CodeAssist uses Hugging Face tokens for authentication and model uploads.

  1. Visit your Hugging Face profile > Settings > Access Tokens.

  2. Generate a New Token with 'Write' access.

  3. Copy the token string.

  4. When starting CodeAssist, the application will prompt you for the token. Paste it into the terminal or web interface.

Read the Hugging Face Guide for help setting up a token, what it's used for, and basic troubleshooting.

Next Steps

Once setup is complete, open CodeAssist, pick your first LeetCode-style problem, and start coding!

You can view this comprehensive walkthrough for instructions on how to use CodeAssist, any best practices and tips, and what to expect when training models, or visit the Troubleshooting page if you need help setting up CodeAssist.

Last updated