Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document all environment variables Pwndbg depends on #1847

Open
disconnect3d opened this issue Jul 31, 2023 · 0 comments · Fixed by #2198
Open

Document all environment variables Pwndbg depends on #1847

disconnect3d opened this issue Jul 31, 2023 · 0 comments · Fixed by #2198

Comments

@disconnect3d
Copy link
Member

We should document all envvars Pwndbg depends on.

Those are:

PATH
EDITOR, VISUAL -- used by cymbol command
HOME, XDG_CACHE_HOME -- used by lib.tempfile

PWNDBG_VENV_PATH
PWNDBG_DISABLE_COLORS

OPENAI_API_KEY, ANTHROPIC_API_KEY -- for ai command

GITHUB_ACTIONS, RUN_FLAKY -- used by tests_commands.py

PWNDBG_PROFILE -- for benchmarking
USE_PDB -- used in tests
PWNDBG_LAUNCH_TEST -- used by tests

PWNDBG_ARCH, PWNDBG_KERNEL_TYPE, PWNDBG_KERNEL_VERSION -- used by gdblib kernel tests

SPHINX -- used by docs/source/conf.py -- probably to be removed?

Additionally, Pwndbg sets PWNLIB_NOTERM=1 to work around some Pwntools stuff

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging a pull request may close this issue.

2 participants