IntenseWebs/opentofu
3
0
Fork 0
mirror of https://github.com/opentofu/opentofu.git synced 2024-12-22 15:13:29 -06:00
Code Issues Packages Projects Releases Wiki Activity
main
opentofu/scripts/debug-opentofu

27 lines
1.1 KiB
Plaintext
Raw Permalink Normal View History

scripts: helper for launching Terraform in the dlv debugger This launches Terraform inside a headless dlv configured to accept a remote debugging process. It's configured this way so it can be easily used from a debugger GUI integrated into an IDE/editor, but it can also be used from the CLI by running the command it prints. Using a remote debugger here is useful even when debugging with the CLI, since it keeps Terraform's verbose and colorful output from interfering with the debugger UI.
2017-10-09 12:23:07 -05:00
#!/usr/bin/env bash
Update scripts directory to OpenTofu (#508)
2023-09-20 08:51:36 -05:00
# This is a helper script to launch OpenTofu inside the "dlv" debugger,
scripts: helper for launching Terraform in the dlv debugger This launches Terraform inside a headless dlv configured to accept a remote debugging process. It's configured this way so it can be easily used from a debugger GUI integrated into an IDE/editor, but it can also be used from the CLI by running the command it prints. Using a remote debugger here is useful even when debugging with the CLI, since it keeps Terraform's verbose and colorful output from interfering with the debugger UI.
2017-10-09 12:23:07 -05:00
# configured to await a remote debugging connection on port 2345. You can
# then connect to it using the following command, or its equivalent in your
# debugging frontend of choice:
# dlv connect 127.0.0.1:2345
#
# This tool does not install dlv. To install it, see its instructions:
Add DEBUGGING.md (#711) Signed-off-by: Serdar Dalgıç <sd@serdardalgic.org> Co-authored-by: James Humphries <James@james-humphries.co.uk>
2023-10-25 10:11:12 -05:00
# https://github.com/go-delve/delve/tree/master/Documentation/installation
scripts: helper for launching Terraform in the dlv debugger This launches Terraform inside a headless dlv configured to accept a remote debugging process. It's configured this way so it can be easily used from a debugger GUI integrated into an IDE/editor, but it can also be used from the CLI by running the command it prints. Using a remote debugger here is useful even when debugging with the CLI, since it keeps Terraform's verbose and colorful output from interfering with the debugger UI.
2017-10-09 12:23:07 -05:00
#
# For more convenient use, you may wish to put this script in your PATH:
Update scripts directory to OpenTofu (#508)
2023-09-20 08:51:36 -05:00
# ln -s ../src/github.com/opentofu/opentofu/scripts/debug-opentofu $GOPATH/bin/debug-opentofu
scripts: helper for launching Terraform in the dlv debugger This launches Terraform inside a headless dlv configured to accept a remote debugging process. It's configured this way so it can be easily used from a debugger GUI integrated into an IDE/editor, but it can also be used from the CLI by running the command it prints. Using a remote debugger here is useful even when debugging with the CLI, since it keeps Terraform's verbose and colorful output from interfering with the debugger UI.
2017-10-09 12:23:07 -05:00
#
Update scripts directory to OpenTofu (#508)
2023-09-20 08:51:36 -05:00
# Note that when running this script the OpenTofu binary is NOT in $GOPATH/bin,
# so any providers installed there won't be found unless OpenTofu searches
scripts: helper for launching Terraform in the dlv debugger This launches Terraform inside a headless dlv configured to accept a remote debugging process. It's configured this way so it can be easily used from a debugger GUI integrated into an IDE/editor, but it can also be used from the CLI by running the command it prints. Using a remote debugger here is useful even when debugging with the CLI, since it keeps Terraform's verbose and colorful output from interfering with the debugger UI.
2017-10-09 12:23:07 -05:00
# there for some _other_ reason.
set -eu
Update scripts directory to OpenTofu (#508)
2023-09-20 08:51:36 -05:00
echo "Launching OpenTofu in a headless debug session"
scripts: helper for launching Terraform in the dlv debugger This launches Terraform inside a headless dlv configured to accept a remote debugging process. It's configured this way so it can be easily used from a debugger GUI integrated into an IDE/editor, but it can also be used from the CLI by running the command it prints. Using a remote debugger here is useful even when debugging with the CLI, since it keeps Terraform's verbose and colorful output from interfering with the debugger UI.
2017-10-09 12:23:07 -05:00
echo "Connect to it using: dlv connect 127.0.0.1:2345"
Update scripts directory to OpenTofu (#508)
2023-09-20 08:51:36 -05:00
echo "(OpenTofu takes a long time to build and launch in this mode; some logs will appear below)"
scripts: helper for launching Terraform in the dlv debugger This launches Terraform inside a headless dlv configured to accept a remote debugging process. It's configured this way so it can be easily used from a debugger GUI integrated into an IDE/editor, but it can also be used from the CLI by running the command it prints. Using a remote debugger here is useful even when debugging with the CLI, since it keeps Terraform's verbose and colorful output from interfering with the debugger UI.
2017-10-09 12:23:07 -05:00
echo "---------------------------"
Rename github.com/placeholderplaceholderplaceholder/opentf to github.com/opentofu/opentofu (#461)
2023-09-20 06:35:35 -05:00
exec dlv debug github.com/opentofu/opentofu --headless --listen :2345 --log -- "$@"
Reference in New Issue Copy Permalink