Skip to main content

Installation

Install from sources​

First, check if the necessary dependencies (pkg-config and libunwind-dev) are installed:

For example, on Ubuntu/Debian:

apt install pkg-config libunwind-dev

Now install the debugger:

cargo install bugstalker

That's all, the bs command is available now!

Problem with libunwind?

If you have any issues with libunwind, you can try to install bs with a native unwinder (currently, I don't recommend this method because libunwind is better :))

cargo install bugstalker --no-default-features

Distro Packages​

Packaging status

Packaging status

Arch Linux​

pacman -S bugstalker

Nix package manager​

There's flake which you can use to start using it. Just enable flakes then you're able to use it with:

nix run github:godzie44/BugStalker

BugStalker also provides a package which you can include in your NixOS config. For example:

Details
{
  inputs = {
    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
    bugstalker.url = "github:godzie44/BugStalker";
  };

  outpus = {nixpkgs, bugstalker, ...}: {
    nixosConfigurations.your_hostname = nixpkgs.lib.nixosSystem {
      modules = [
        ({...}: {
          environment.systemPackages = [
            # assuming your system runs on a x86-64 cpu
            bugstalker.packages."x86_64-linux".default
          ];
        })
      ];
    };
  };
}

Home-Manager​

There's a home-manager module which adds programs.bugstalker to your home-manager config. You can add it by doing the following:

Details
{
  description = "NixOS configuration";

  inputs = {
    nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
    home-manager.url = "github:nix-community/home-manager";
    home-manager.inputs.nixpkgs.follows = "nixpkgs";
    bugstalker.url = "github:godzie44/BugStalker";
  };

  outputs = inputs@{ nixpkgs, home-manager, bugstalker, ... }: {
    nixosConfigurations = {
      hostname = nixpkgs.lib.nixosSystem {
        system = "x86_64-linux";
        modules = [
          ./configuration.nix
          home-manager.nixosModules.home-manager
          {
            home-manager.sharedModules = [
              bugstalker.homeManagerModules.default
              ({...}: {
                programs.bugstalker = {
                  enable = true;
                  # the content of `keymap.toml`
                  keymap = {
                    common = {
                      up = ["k"];
                    }
                  };
                };
              })
            ];
          }
        ];
      };
    };
  };
}