Skip to content

Commit 8cf24bd

Browse files
Madman10Kalehander92
authored andcommitted
docs(env): Document our environment variables
1 parent fb71d46 commit 8cf24bd

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
CodeTracer exposes a number of environment variables that you can use to override some of its behaviours:
2+
3+
1. `CODETRACER_ELECTRON_ARGS` - adds arguments for launching Electron. Useful for debugging production builds
4+
1. `CODETRACER_WRAPPER_PID` - overrides the process ID of the `ct` CodeTracer wrapper
5+
1. `CODETRACER_CALLTRACE_MODE` - changes the calltrace mode
6+
1. `CODETRACER_RECORD_CORE` - this does nothing as it is only related to the unreleased system backend
7+
8+
## CodeTracer Shell
9+
These are generally not functional right now, since they affect CodeTracer Shell, which is currently not implemented:
10+
11+
1. `CODETRACER_SHELL_BASH_LOG_FILE` - overrides the log file
12+
1. `CODETRACER_SHELL_ID` - overrides the shell ID
13+
1. `CODETRACER_SESSION_ID` - overrides the CodeTracer Shell session ID so that the current commands affect a previous shell session
14+
1. `CODETRACER_SHELL_REPORT_FILE` - overrides the report file of CodeTracer Shell
15+
1. `CODETRACER_SHELL_USE_SCRIPT` - ?
16+
1. `CODETRACER_SHELL_RECORDS_OUTPUT` - ?
17+
1. `CODETRACER_SHELL_EXPORT` - ?
18+
1. `CODETRACER_SHELL_CLEANUP_OUTPUT_FOLDER` - ?
19+
1. `CODETRACER_SHELL_SOCKET` and `CODETRACER_SHELL_ADDRESS` - they override the socket location and address respectively

docs/experimental-documentation/_Sidebar.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
- Limitations
2727
- [Troubleshooting](https://dev-docs.codetracer.com/Introduction/Troubleshooting)
2828
- Advanced topics
29+
- [Environment variables](https://dev-docs.codetracer.com/Advanced/EnvironmentVariables)
2930
- Custom patches
3031
- Dotfiles
3132
- Misc

0 commit comments

Comments
 (0)