How do I use Bear to generate compile_commands.json for a Makefile project?

Run 'bear -- make' in your project directory. Bear will intercept the compiler calls during the build and output the JSON file, which you can then use with Clang tools like clang-tidy or clangd.

Bear vs CMake's built-in compilation database: which should I use?

If your project uses CMake, prefer its native 'CMAKE_EXPORT_COMPILE_COMMANDS' option—it's faster and more reliable. Bear is best for non-CMake projects where native support isn't available.

Does Bear work with Visual Studio builds on Windows?

Yes, Bear supports Windows, but you might need to verify it captures MSVC compiler calls correctly; check the project wiki for platform-specific tips and potential workarounds.

Why is Bear not capturing all compiler calls in my build?

This can happen in sandboxed environments or with complex build scripts. Consult the wiki for issues related to macOS SIP or Nix, and ensure your build command is correctly prefixed with 'bear --'.

What are good alternatives to Bear for generating compilation databases?

For supported build systems, use native tools like CMake or Meson. Other options include 'compiledb' for Python-based projects, but Bear remains a popular cross-platform fallback for unsupported systems.

How can I integrate Bear with clangd for IDE code navigation?

Generate the compilation database with Bear, then configure your IDE to point clangd to the directory containing compile_commands.json. This enables accurate code analysis and navigation for C/C++ projects.

Open-Awesome

Bear

GPL-3.0Rust4.2.2

A tool that generates a JSON compilation database for Clang-based tools by intercepting compiler calls during a build.

GitHub

6.5k stars369 forks0 contributors

What is Bear?

Bear is a command-line tool that generates a JSON compilation database for Clang-based tooling. It solves the problem of obtaining a compilation database from build systems that do not natively support exporting one, by intercepting compiler invocations during the build process.

Target Audience

C/C++ developers and teams using Clang-based tools (like clang-tidy, clangd, or ccls) for static analysis, refactoring, or IDE integration, especially those with non-CMake/Meson/Bazel build systems.

Value Proposition

Developers choose Bear because it provides a simple, cross-platform way to generate compilation databases without modifying build scripts, enabling advanced Clang tooling support in environments where native database generation is unavailable.

Overview

Generate compile_commands.json for any C or C++ build

Use Cases

Best For

Generating compilation databases for Makefile-based projects
Enabling Clang tooling in legacy or custom build systems
Integrating clangd or clang-tidy into IDEs for C/C++ projects
Running static analysis on projects with unsupported build systems
Setting up code navigation and refactoring tools in non-CMake environments
Capturing compiler flags for cross-platform C/C++ development

Not Ideal For

Projects using CMake, Meson, or Bazel with native compilation database support
Sandboxed build environments like Nix or Flatpak without additional configuration
Highly parallel or distributed builds where compiler interception may miss invocations
Real-time development workflows requiring zero-overhead build monitoring

Pros & Cons

Pros

Cross-Platform Support

Works on Linux, macOS, multiple BSD variants, and Windows, as explicitly listed in the README, ensuring broad compatibility.

Simple Command-Line Usage

Just prefix your build command with 'bear --', making it easy to integrate without modifying build scripts, as highlighted in the usage section.

Pragmatic Fallback Solution

Provides a reliable alternative for build systems lacking native JSON compilation database export, focusing on simplicity as per the philosophy.

Automatic Compiler Capture

Intercepts compiler invocations during builds to generate the database automatically, enabling Clang tooling support for unsupported systems.

Cons

Environment-Specific Hurdles

Requires extra configuration for macOS System Integrity Protection or sandboxed builds like Nix, as noted in the limitations section of the README.

Interception Reliability Issues

May miss compiler calls in complex build setups, such as those using wrapper scripts or indirect invocations, leading to incomplete databases.

Performance Overhead

Build interception adds overhead, making it slower and less efficient compared to native compilation database generation in tools like CMake.

Frequently Asked Questions

Related Projects

Vcpkg

C++ Library Manager for Windows, Linux, and MacOS

Stars27,451

Forks7,710

Last commit4 days ago

Buck

A fast build system that encourages the creation of small, reusable modules over a variety of platforms and languages.

Stars8,541

Forks1,130

Last commit2 years ago

Sccache

Sccache is a ccache-like tool. It is used as a compiler wrapper and avoids compilation when possible. Sccache has the capability to utilize caching in remote storage environments, including various cloud storage options, or alternatively, in local storage.

Stars7,661

Forks739

Last commit5 days ago

awesome-cmake

A curated list of awesome CMake resources, scripts, modules and examples.

Stars5,416

Forks490

Last commit26 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