OpenResearch

Environment Variables

OpenResearch stores compute credentials and experiment secrets in ~/.openresearch/env on your computer. They stay out of your repositories but are available to the runs you launch.

Add a variable

Open the Environment page in the app (or run orx up for the browser dashboard). Add each key and value; saved values are masked when you return.

Compute credentials

  • HF_TOKEN: Hugging Face Jobs. The token needs Jobs write permission.
  • MODAL_TOKEN_ID and MODAL_TOKEN_SECRET: Modal.
  • TINKER_API_KEY: Thinking Machines Tinker.
  • Any API keys or configuration your experiments need at runtime.

You can also save backend credentials with orx compute configure --credentials-file. See Compute Backends.

Precedence

Variables already set in the environment where orx runs override values saved in ~/.openresearch/env.