[Docs] Document environment variables and internal-* SLURM configs in the README - #77
Open
aaronsmulktis wants to merge 2 commits into
Open
Conversation
… the README
Cloners running OpenApps on a cluster had to read the scripts to find the knobs.
Add two README sections:
- Environment variables: the .env / load_dotenv path, the vars read by configs
and code (USER, GPT55_API_KEY, AWS_*, WANDB_*, EXPERIMENT_CONFIG_PATH,
OPENAPPS_MCP_*), how to point an agent's api_key at any env var via Hydra
interpolation, and the env knobs for scripts/conduct.sh and conduct_slurm.sh.
- Running on SLURM: the gitignored internal-* convention (copy
config/mode/slurm_cluster.yaml to config/mode/internal-slurm_cluster.yaml and
select it with mode=internal-slurm_cluster), a placeholder example of that
file, vLLM host wiring, and submit-time SBATCH overrides.
Also fixes the stale quickstart example: agent=GPT-5-1 no longer exists (renamed
to the GPT-5.5-* configs), so the command as written fails to resolve in Hydra.
Verified: 'agent.api_key=${oc.env:OPENAI_API_KEY}' resolves via --cfg job
--resolve, and mode=internal-slurm_cluster composes.
aaronsmulktis
force-pushed
the
aaronsmulktis/readme-env-vars
branch
from
September 1, 2026 00:38
dc788e5 to
1c097f5
Compare
Adds a commented .env.example covering the variables load_dotenv() actually feeds into the configs (GPT55_API_KEY / any api_key via Hydra interpolation, the AWS trio for Bedrock, WANDB_*), so 'cp .env.example .env' is the whole setup step. README follow-ups for accuracy: - point at .env.example instead of an inline heredoc; - state explicitly that conduct.sh / conduct_slurm.sh and the MCP server read their variables from the shell, not from .env -- only launch_agent.py and launch_parallel_agents.py call load_dotenv() -- with the 'set -a; source .env' idiom for people who want to keep them in one file; - move OPENAPPS_APP / OPENAPPS_MCP_HOST / OPENAPPS_MCP_PORT into that shell-level table, with their defaults and CLI equivalents; - drop the EXPERIMENT_CONFIG_PATH row: load_config() in configs.py has no callers, so documenting it invites people to set a variable that does nothing.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Two new README sections for people cloning the repo to run OpenApps on a cluster, plus one stale-example fix.
Environment variables
.env/load_dotenv()path (bothlaunch_agent.pyandlaunch_parallel_agents.pycall it).USER(W&Bentity+logs_dir),GPT55_API_KEY, the AWS trio forclaude_4_sonnet(client_type: aws),WANDB_API_KEY/WANDB_BASE_URL/WANDB_MODE,EXPERIMENT_CONFIG_PATH, andOPENAPPS_APP/OPENAPPS_MCP_HOST/OPENAPPS_MCP_PORT.api_keyat whatever variable you use, via Hydra interpolation.scripts/conduct.sh(AGENTS,COUNT,MAX_PARALLEL,HEADLESS,LOG_DIR,WANDB_GROUP) andscripts/conduct_slurm.sh(VLLM_MODEL,VLLM_PORT,VLLM_HOST).Running on SLURM
config/mode/slurm_cluster.yamlships placeholders thatsbatchrejects. Documents the existing gitignoredinternal-*convention: copy it toconfig/mode/internal-slurm_cluster.yaml, fill in real paths/account/QOS, and select it withmode=internal-slurm_cluster. Includes a placeholder-only example of that file.agent.hostname/agent.port), whatconduct_slurm.shdiscovery does, and overriding account/QOS/partition at submit time rather than editing the#SBATCHlines.Drive-by fix: the quickstart used
agent=GPT-5-1, which was renamed to theGPT-5.5-*configs — the command as written fails to resolve in Hydra. Nowagent=GPT-5.5-computer-usewith the matchingGPT55_API_KEY. Happy to split this out if preferred.Test plan
Docs only — no code changes. Claims verified against the repo:
No cluster paths, hostnames, account names, or QOS names in the added text — placeholders only.