Skip to content

SWE-agent takes a GitHub issue and tries to automatically fix it, using your LM of choice. It can also be employed for offensive cybersecurity or competitive coding challenges. [NeurIPS 2024]

Doc fix: Remove leftover env var documentation (#975)

Kilian Lieretf9099b03866c
diff --git a/docs/config/env.md b/docs/config/env.md
index f2b70e76..a82cbeda 100644
--- a/docs/config/env.md
+++ b/docs/config/env.md
@@ -1,27 +1,14 @@
# Environment variables
-!!! hint "Persisting environment variables"
- All environment variables can also be added to `keys.cfg` instead.
- See [here](../installation/keys.md) for more information.
-
This page details all environment variables that are currently in use by SWE-agent.
* All API keys (for LMs and GitHub) can be set as an environment variable. See [here](../installation/keys.md) for more information.
* `SWE_AGENT_CONFIG_ROOT`: Used to resolve relative paths in the [config](config.md)
-* `SWE_AGENT_ENV_LONG_TIMEOUT` (default: 500): Timeout in seconds used for commands that install instance environment.
-* `SWE_AGENT_ACTION_TIMEOUT` (default: 25): Timeout in seconds used for commands issued by the agent
-* `SWE_AGENT_ACTION_NO_OUTPUT_TIMEOUT` (default: equal to `SWE_AGENT_ACTION_TIMEOUT`): Timeout in seconds used when no output is produced for the defined duration for commands issued by the agent
-* `SWE_AGENT_MODEL_MAX_RETRIES` (default: 10): Maximum retries when querying the model
The following three variables can only be set as environment variables, not in the config file
* `SWE_AGENT_LOG_TIME`: Add timestamps to log
-* `SWE_AGENT_LOG_STREAM_LEVEL`: Level of logging that is shown on the command line interface (`TRACE` being a custom level below `DEBUG`)
-* `SWE_AGENT_LOG_FILE_LEVEL`: Like `SWE_AGENT_LOG_STREAM_LEVEL` but for the log file
+* `SWE_AGENT_LOG_STREAM_LEVEL`: Level of logging that is shown on the command line interface (`TRACE` being a custom level below `DEBUG`). Will have no effect for `run-batch`.
-!!! warning "Unstable"
- The following variables might still be subject to change
-
-* `SWE_AGENT_COMMUNICATE_METHOD`: Determines how SWE-agent communicates with the running process in the docker container: `end-marker` (default, fast) or `processes` (legacy, slow, more tested)
-* `SWE_AGENT_CLONE_METHOD`: `shallow` (default, only retrieves relevant commit) or `full` (clones repository including full history). When using persistent containers or running over multiple problem statements, we fall back to `full`.
-* `SWE_AGENT_DOCKER_START_UP_DELAY`: Number of seconds to wait after starting a docker container
+!!! hint "Persisting environment variables"
+ Most environment variables can also be added to `.env` instead.
\ No newline at end of file