How do I use Gebug with Visual Studio Code for debugging?

Gebug sets up Delve on a default port (40000); in VSCode, create a launch config to attach to localhost:40000. The demo GIF shows this integration, and you can adjust the port in config.yaml if needed.

Is Gebug or manual Docker setup better for Go debugging?

Gebug saves time by auto-generating configs, ideal for standard Go apps in Docker. For highly customized builds or advanced Docker features, manual setup might offer more control and flexibility.

Can Gebug work with Kubernetes instead of Docker Compose?

No, Gebug is built around Docker and Docker Compose; for Kubernetes, you'd need to manually adapt the generated files or use other tools specific to k8s debugging environments.

How to add custom build commands in Gebug?

Edit the config.yaml file in the .gebug directory, modify the 'build_command' field, and use 'gebug start --skip-generate' to apply changes. The Web UI also allows edits through a browser interface.

Does Gebug support debugging multiple services at once?

It uses docker-compose, so you can configure multiple services in the generated files, but Gebug's primary focus is on a single Go application; multi-service setups may require manual docker-compose extensions.

What are the performance implications of using Gebug's hot-reload?

Hot-reload rebuilds on every change, which is fine for small projects, but for large codebases, build times might slow down the iteration cycle unless you optimize the build_command in config.yaml.

Open-Awesome

Gebug

Apache-2.0Gov1.0.7

A tool that simplifies debugging Dockerized Go applications with integrated debugger and hot-reload capabilities.

GitHub

634 stars17 forks0 contributors

What is Gebug?

Gebug is a command-line tool that simplifies debugging Go applications running inside Docker containers. It automatically sets up a debugging environment with Delve integration and hot-reload functionality, eliminating manual configuration of Dockerfiles and docker-compose setups. The tool generates the necessary configuration files and manages the container lifecycle for an optimized debugging workflow.

Target Audience

Go developers who build and debug applications using Docker containers, particularly those working with microservices or containerized deployments who need efficient debugging workflows.

Value Proposition

Developers choose Gebug because it dramatically reduces the setup time for debugging Dockerized Go applications, provides both debugger integration and hot-reload in one tool, and maintains transparency by generating editable configuration files rather than hiding the implementation details.

Overview

Debug Dockerized Go applications better

Use Cases

Best For

Debugging Go microservices running in Docker containers
Setting up hot-reload for Go applications during development
Integrating Delve debugger with Dockerized Go projects
Simplifying Docker configuration for Go development environments
Teams transitioning from local Go development to containerized workflows
Developers who want both CLI and web UI options for managing debug configurations

Not Ideal For

Projects not using Docker containers for development or deployment
Teams requiring debugging with tools other than Delve (e.g., GDB or native debuggers)
Environments using Kubernetes or complex orchestrators where Docker Compose is insufficient
Applications locked to Go versions below 1.24 or older Docker/Docker Compose versions

Pros & Cons

Pros

Automatic Configuration Generation

Generates Dockerfile and docker-compose.yml files tailored for Go debugging, eliminating manual setup as described in the 'How Does It Work' section.

Seamless Delve Integration

Configures Delve debugger with proper compiler flags for breakpoints, demonstrated in demos with Goland and VSCode for step-through debugging.

Hot-Reload Development

Watches source changes and auto-rebuilds/restarts the application, streamlining workflows as shown in the hot-reload GIF.

Dual Interface Flexibility

Provides both CLI and Web UI for managing settings, catering to different preferences, with the UI accessible via 'gebug ui' command.

Cons

Version Dependency Constraints

Requires Go 1.24+, Docker 20.10+, and Docker Compose 2.0+, which can block adoption in environments with legacy tooling or strict versioning.

Manual Edit Complexity

Customizations require running 'gebug start --skip-generate' to avoid overrides, adding operational overhead and risk of misconfiguration.

Narrow Ecosystem Focus

Limited to Go applications within Docker; unsuitable for multi-language projects or non-containerized debugging, reducing general utility.

Breaking Upgrade Disruption

Version 2.0 introduced breaking changes like Go 1.24 minimum and new defaults, forcing project reinitialization that can disrupt existing workflows.

Frequently Asked Questions

Related Projects

croc

Easily and securely send things from one computer to another :crocodile: :package:

Stars34,907

Forks1,379

Last commit9 days ago

restic

Fast, secure, efficient backup program

Stars33,392

Forks1,747

Last commit5 days ago

gor

GoReplay is an open-source tool for capturing and replaying live HTTP traffic into a test environment in order to continuously test your system with real data. It can be used to increase confidence in code deployments, configuration changes and infrastructure changes.

Stars19,290

Forks88

Last commit3 months ago

JuiceFS

JuiceFS is a distributed POSIX file system built on top of Redis and S3.

Stars13,542

Forks1,201

Last commit6 days ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub