Configuration
Most of Rye's configuration is contained within the pyproject.toml file. There is however
also a bit of global configuration to influence how it works.
Changing Home Folder
By default Rye places all its configuration in ~/.rye on Unix and %USERPROFILE%\.rye on
Windows. This behavior can be changed via the RYE_HOME environment variable. This is useful
if you do not like the default location where Rye places its configuration or if you need
to isolate it.
Home Folder Structure
The .rye home folder contains both user configuration as well as Rye-managed state such
as installed toolchains. The following files and folders are placed within the
.rye folder. Note that not all are always there.
config.toml
This is a configuration file that influences how Rye operates. Today very little configuration is available there. For the available config keys see Config File.
self
While Rye is written in Rust, it uses a lot of Python tools internally. These are maintained in an internal virtualenv stored in this location.
py
In this folder Rye stores the different toolchains. Normally those are folders containing downloaded Python distributions, but they can also be symlinks or special reference files.
shims
This folder contains shim binaries. These binaries are for instance the python executable
which automatically proxies to the current virtualenv or globally installed tools.
Config File
The config file config.toml in the .rye folder today is only used to manage defaults. This
is a fully annotated config file:
[default]
# This is the default value that is written into new pyproject.toml
# files for the `project.requires-python` key
requires-python = ">= 3.8"
# This is the default toolchain that is used
toolchain = "[email protected]"
# This is the default build system that is used
build-system = "hatchling"
# This is the default license that is used
license = "MIT"
# This sets the default author (overrides the defaults from git). The
# format here is "Name <email>".
author = "Full Name <[email protected]>"
# The dependency operator to use by default for dependencies. The options are
# '>=', '~=', and '=='. The default currently is '>='. This affects the behavior
# of `rye add`.
dependency-operator = ">="
[proxy]
# the proxy to use for HTTP (overridden by the http_proxy environment variable)
http = "http://127.0.0.1:4000"
# the proxy to use for HTTPS (overridden by the https_proxy environment variable)
https = "http://127.0.0.1:4000"
[behavior]
# When set to `true` the `managed` flag is always assumed to be `true`.
force-rye-managed = false
# Enables global shims when set to `true`. This means that the installed
# `python` shim will resolve to a Rye-managed toolchain even outside of
# virtual environments.
global-python = false
# Enable or disable automatic `sync` after `add` and `remove`. This defaults
# to `true` when uv is enabled and `false` otherwise.
autosync = true
# Marks the managed .venv in a way that cloud-based synchronization systems
# like Dropbox and iCloud Files will not upload it. This defaults to `true`
# as a .venv in cloud storage typically does not make sense. Set this to
# `false` to disable this behavior.
venv-mark-sync-ignore = true
# When set to `true` Rye will fetch certain interpreters with build information.
# This will increase the space requirements, will put the interpreter into an
# extra folder called `./install/` and place build artifacts adjacent in `./build`.
fetch-with-build-info = false
# An array of tables with optional sources. Same format as in pyproject.toml
[[sources]]
name = "default"
url = "https://pypi.org/simple/"
Manipulating Config
new in 0.9.0
The configuration can be read and modified with rye config. The
keys are in dotted notation. --get reads a key, --set, --set-int,
--set-bool, and --unset modify one.
rye config --set proxy.http=http://127.0.0.1:4000
rye config --set-bool behavior.force-rye-managed=true
rye config --get default.requires-python
For more information see config.
Per Project Config
For the project-specific pyproject.toml config see pyproject.toml.