Prerequisites

System requirements and dependencies for typemux-cc

Before installing typemux-cc, ensure your system meets the requirements and has the necessary dependencies installed.

Supported Platforms

macOS

arm64 only (Apple Silicon)

Intel macOS users must build from source

Linux

x86_64 and arm64 architectures supported

Windows is currently unsupported due to path handling differences.

If you need Windows support, consider using WSL2 (Windows Subsystem for Linux).

Required Dependencies

1. LSP Backend

typemux-cc requires at least one Python type-checker backend. Choose from:

pyright (Recommended)

pyright is the default and most stable backend.

npm

npm install -g pyright

Verify installation:

pyright-langserver --version

pyright is used by default when TYPEMUX_CC_BACKEND is not set.

ty (Experimental)

ty is an experimental backend by the creators of uv.

pip

pip install ty

Verify installation:

ty --version

To use ty, set TYPEMUX_CC_BACKEND=ty in your configuration.

pyrefly (Experimental)

pyrefly is an experimental backend by Meta.

pip

pip install pyrefly

Verify installation:

pyrefly --version

To use pyrefly, set TYPEMUX_CC_BACKEND=pyrefly in your configuration.

2. Git (Optional but Recommended)

Git is used to determine the .venv search boundary. typemux-cc works without git, but venv detection is more reliable within git repositories.

Verify git is installed:

git --version

If git is not available, typemux-cc will search for .venv up to the filesystem root instead of stopping at the repository boundary.

System Dependencies

Rust Version (Local Build Only)

If you plan to build from source, you’ll need:

• Rust 1.75 or later
• Cargo (included with Rust)

Check your Rust version:

rustc --version
cargo --version

Install or update Rust:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Marketplace installation does not require Rust—prebuilt binaries are downloaded automatically.

Virtual Environment Requirements

typemux-cc has strict requirements for Python virtual environments:

1. Must be named .venv

   Only directories named .venv are recognized. Other names (like venv, .env, or custom names) are not supported.

2. Must contain pyvenv.cfg

   The .venv directory must contain a pyvenv.cfg file. This file is created automatically by standard tools:

   • python -m venv .venv
   • uv sync
   • uv venv
3. Must be a real directory

   Symlinks to .venv may fail detection. Use actual directories when possible.

Poetry, Conda, and other non-standard environments are not supported.

typemux-cc intentionally uses strict detection to avoid silently using the wrong environment. If you use poetry or conda, create a .venv directory or symlink.

Verifying Your Virtual Environment

Check if your .venv will be detected:

# Verify pyvenv.cfg exists
ls -la .venv/pyvenv.cfg

# View pyvenv.cfg contents
cat .venv/pyvenv.cfg

Expected output:

home = /usr/bin
include-system-site-packages = false
version = 3.11.7

Network Requirements (Marketplace Only)

Marketplace installation requires:

• GitHub API access (api.github.com)
• GitHub release downloads (github.com)
• curl command-line tool

If you’re behind a corporate firewall or in an offline environment, use the local build method instead.

If you encounter rate limiting from GitHub API, wait a few minutes or authenticate with the GitHub CLI (gh auth login) to increase your rate limit.

Next Steps

Once you have the prerequisites installed:

Marketplace Install

Install from GitHub releases (recommended)

Local Build

Build from source with Rust/Cargo