Creates a new Mojo or MAX project. Use when wanting to start a new Mojo or MAX project, initializing the Pixi or UV environment to use Mojo or MAX, or when the user wants to begin a new Mojo or MAX project from scratch.
When the user wants to create a new project, first infer as many options as possible from the user's request (e.g., "new Mojo project" means type=Mojo, "called foo" means name=foo). Then use a structured multiple-choice prompt (not plain text) to gather only the remaining unspecified options in a single interaction. Do NOT ask about options the user has already provided or implied. The options to determine are:
uv init + uv add,
recommended) or quick uv environment (uv venv + uv pip install, lighter
weight)Then follow the appropriate section below (Pixi or uv) to initialize the
project and choose max or mojo as appropriate. For stable versions in the
below examples, mojo will start with a 0. prefix (0.26.1.0.0.0) where
packages will not (26.1.0.0.0).
maxNOTE: Do not look for or use magic for Mojo or MAX projects, it is no longer
supported. Pixi has fully replaced its capabilities.
Pixi manages Python, Mojo, and other dependencies in a reproducible manner inside a controlled environment.
First, determine if pixi is installed. If it is not available for use at the
command line, install it using the latest instructions found on
https://pixi.prefix.dev/latest/#installation
You may need to place the pixi tool in the local shell environment after
installation if it had not already been installed.
# New project
pixi init [PROJECT] \
-c https://conda.modular.com/max-nightly/ -c conda-forge \
&& cd [PROJECT]
pixi add [max / mojo]
pixi shell
# Existing project - add to pixi.toml channels first:
# [workspace]
# channels = ["https://conda.modular.com/max-nightly/", "conda-forge"]
pixi add [max / mojo]
# New project
pixi init [PROJECT] \
-c https://conda.modular.com/max/ -c conda-forge \
&& cd [PROJECT]
pixi add "[max / mojo]==0.26.1.0.0.0"
pixi shell
# Existing project
pixi add "[max / mojo]==0.26.1.0.0.0"
uv is a fast and very popular package manager, familiar to developers coming from a Python background. It also works well with Mojo projects.
uv init [PROJECT] && cd [PROJECT]
uv add [max / mojo] \
--index https://whl.modular.com/nightly/simple/ \
--prerelease allow
uv init [PROJECT] && cd [PROJECT]
uv add [max / mojo] \
--extra-index-url https://modular.gateway.scarf.sh/simple/
mkdir [PROJECT] && cd [PROJECT]
uv venv
uv pip install [max / mojo] \
--index https://whl.modular.com/nightly/simple/ \
--prerelease allow
mkdir [PROJECT] && cd [PROJECT]
uv venv
uv pip install [max / mojo] \
--extra-index-url https://modular.gateway.scarf.sh/simple/
When using uv, you can use max or mojo directly by working within the
project environment:
source .venv/bin/activate
Standard Python package manager.
python3 -m venv .venv && source .venv/bin/activate
pip install --pre [max / mojo] \
--index https://whl.modular.com/nightly/simple/
python3 -m venv .venv && source .venv/bin/activate
pip install [max / mojo] \
--extra-index-url https://modular.gateway.scarf.sh/simple/
For conda/mamba users.
conda install -c conda-forge \
-c https://conda.modular.com/max-nightly/ [max / mojo]
conda install -c conda-forge \
-c https://conda.modular.com/max/ "[max / mojo]==0.26.1.0.0.0"
If using MAX with custom Mojo kernels, versions must match:
# Check alignment
uv pip show mojo | grep Version # e.g., 0.26.2
pixi run mojo --version # Must match major.minor (e.g., 0.26.2)
Mismatched versions cause kernel compilation failures. Always use the same channel (stable or nightly) for both.