Skip to content
This repository was archived by the owner on Feb 5, 2026. It is now read-only.

Set environment variables to provide context to scripts#1324

Open
brandon-avantus wants to merge 1 commit intoastral-sh:mainfrom
brandon-avantus:rye-run-environment-variables
Open

Set environment variables to provide context to scripts#1324
brandon-avantus wants to merge 1 commit intoastral-sh:mainfrom
brandon-avantus:rye-run-environment-variables

Conversation

@brandon-avantus
Copy link
Copy Markdown

Sets the environment variables listed below to allow scripts to have some context when determining what to do and where to do it. This also provides some information to create Python packages for experimenting with some suggested rye run features.

Environment Variables:

  • WORKING_DIR: Initial working directory. Useful in env files
  • RYE: Full path of the rye executable running the command. Useful for scripts that call rye
  • RYE_RUN_CMD: Name of the command being run. Helpful for commands that run the same script to differentiate the command or for scripts to read the command entry from pyproject.toml
  • PROJECT_ROOT: Full path of the directory containing pyproject.toml. Useful for scripts to do work relative to the project root or that need to read the pyproject.toml.
  • WORKSPACE_ROOT: Full path of the workspace. Similar to PROJECT_ROOT, but for the workspace

The variables are set on the process before processing env files so they may be used in those files.

Sets the environment variables listed below to allow scripts to have
some context when determining what to do and where to do it. This also
provides some information to create Python packages for experimenting
with some suggested `rye run` features.

Environment Variables:

  WORKING_DIR: Initial working directory. Useful in env files
  RYE: Full path of the rye executable running the command. Useful for
      scripts that call rye
  RYE_RUN_CMD: Name of the command being run. Helpful for commands that
      run the same script to differentiate the command or for scripts
      to read the command entry from pyproject.toml
  PROJECT_ROOT: Full path of the directory containing pyproject.toml.
      Useful for scripts to do work relative to the project root or
      that need to read the pyproject.toml.
  WORKSPACE_ROOT: Full path of the workspace. Similar to PROJECT_ROOT,
      but for the workspace
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant