code-intelligence.com/cifuzz@v0.40.0/docs/Installation-Guide.md (about)

     1  # Installation Guide
     2  
     3  ## Installation Directories
     4  
     5  ### Linux/MacOS
     6  
     7  When running the installer as a **non-root** user, files are installed to:
     8  
     9  - `~/.local/share/cifuzz` (default) or
    10  - `$XDG_DATA_HOME/cifuzz` if `$XDG_DATA_HOME` is set.
    11  
    12  A symlink to the `cifuzz` executable is created in `~/.local/bin/cifuzz`.
    13  
    14  When running the installer as **root**, files are installed to
    15  `/opt/code-intelligence/cifuzz` and a symlink to the `cifuzz` executable
    16  if created in `/usr/local/bin/cifuzz`.
    17  
    18  ### Windows
    19  
    20  All files are installed to `%APPDATA%/cifuzz` with the executable located
    21  in `%APPDATA%/cifuzz/bin`.
    22  
    23  ## How to uninstall cifuzz
    24  
    25  ### Linux / macOS
    26  
    27  #### Version < 0.7.0
    28  
    29  If you installed cifuzz into the default directory as **root**:
    30  
    31  ```bash
    32  sudo rm -rf ~/cifuzz /usr/local/share/cifuzz
    33  ```
    34  
    35  If you installed cifuzz as a **non-root** user:
    36  
    37  ```bash
    38  rm -rf ~/cifuzz ~/.cmake/packages/cifuzz
    39  ```
    40  
    41  If you installed into a custom installation directory you have to remove
    42  that one instead.
    43  
    44  #### Version >= 0.7.0
    45  
    46  From version 0.7.0 the default installation directory has changed.
    47  
    48  If you installed cifuzz as **root**:
    49  
    50  ```bash
    51  sudo rm -rf /opt/code-intelligence/cifuzz /usr/local/bin/cifuzz /usr/local/share/cifuzz
    52  ```
    53  
    54  If you installed cifuzz as a **non-root** user:
    55  
    56  ```bash
    57  rm -rf "${XDG_DATA_HOME:-$HOME/.local/share}/cifuzz" ~/.local/bin/cifuzz ~/.cmake/packages/cifuzz
    58  ```
    59  
    60  If you installed into a custom installation directory you have to remove
    61  that one instead.
    62  
    63  ### Windows
    64  
    65  To uninstall cifuzz and delete the corresponding registry entries:
    66  
    67  ```bash
    68  rd /s %APPDATA%/cifuzz
    69  
    70  reg delete "HKLM\Software\Kitware\CMake\Packages\cifuzz" /f 2> nul
    71  reg delete "HKCU\Software\Kitware\CMake\Packages\cifuzz" /f 2> nul
    72  ```
    73  
    74  ## Using a pre-release installer
    75  
    76  The [Installer Pipeline](https://github.com/CodeIntelligenceTesting/cifuzz/actions/workflows/pipeline_installer.yml)
    77  creates installers (for all supported operating systems) for every
    78  change on the `main` branch and can also be used on other branches too.
    79  
    80  To use one of these installers the following steps have to be executed:
    81  
    82  1. Download the `cifuzz_installer` artifact from the successful pipeline run
    83  2. Unpack the artifact, for example with `unzip cifuzz_installer.zip`
    84  3. Chose the installer for your operating system and run it
    85  
    86  ```
    87  chmod u+x cifuzz_installer_linux
    88  ./cifuzz_installer_linux
    89  ```