Getting Started

Get up and running with CodeAssist and start training local models based to code like you.

GitHub - gensyn-ai/codeassist: A completely private and local AI coding assistant, developed by Gensyn. It helps you practice programming problems and train a novel assistant to help you code.GitHub

Overview

This page helps you prepare your system and choose the correct installation path for CodeAssist.

It provides a readiness checklist, supported platforms, and an overview of the setup process before you begin installing and running CodeAssist on your device.

Before you Begin

CodeAssist is available across several environments: Windows (via WSL 2), Linux (Ubuntu 22.04+), and macOS (Intel and Apple Silicon).

A virtual private server (VPS) is not required to run CodeAssist.

Before you start, make sure you meet the basic requirements and have the necessary accounts.

System Requirements

• 8 GB RAM minimum (32 GB recommended)

• Stable internet connection

• At least 10 GB of available storage (for overhead)

• Modern multi-core CPU (Intel, AMD, or Apple Silicon)

Software Requirements

• Docker

• Python 3.10+

• Homebrew (if installing on macOS)

• Git (for cloning the repo)

Accounts & Access

• Hugging Face account: You’ll need a Write-access API token to upload your model after training. See the Hugging Face Guide for instructions.

• Gensyn Testnet account: Automatically created when you first log in through your browser during setup.

When logging in, different types of External Object Identifiers (EOA) are assigned based on the authentication method used.

Google authentication typically assigns an EOA linked to the user's Google account. On the other hand, logging in via OTP (One-Time Password) often results in an EOA tied to the mobile number or email address used for the OTP process.

Quickstart

You can find the quickstart commands for cloning the repository and installing dependencies below. If you take this route, it's recommended to use an IDE like Cursor in case you experience any initial issues.

1. Run this sequence of commands in your terminal:

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

1. Open CodeAssist, load a LeetCode problem, and check that the container starts successfully.

2. You can also use the following commands to verify you've installed all the required dependencies correctly:

docker --version
python3 --version
uv --version

If you encounter any errors, head over to the Troubleshooting page.

Supported Platforms & Installation Paths

See platform-specific installation instructions below.

Windows (WSL 2)

Install, run, and train models in a Linux-based Windows environment.

Linux (Ubuntu 22.04+)

Install CodeAssist natively on Ubuntu or a compatible distribution for the most stable experience.

macOS (Intel & Apple Silicon)

Install and run CodeAssist on macOS devices using brew or curl for dependency management. Both Intel and M-Series CPUs are supported.