Installation

Download the latest binary

Pick one of the below binaries for your platform.

MacOS
- Apple Silicon: tangle-guard-macos-arm64
- Intel: tangle-guard-macos-x86_64
Linux: tangle-guard-linux-x86_64
Windows: tangle-guard-windows-x86_64.exe

For evaluation and testing

If you just want to test it out, without dealing with the PATH configuration, you can run it directly after it has been downloaded, for example:

MacOS, Linux
Windows

cd Downloads/

# make it executable
chmod +x tangle-guard-*

# start the UI and provide the path to your code directory
./tangle-guard-* -d <target-directory> ui

cd \Downloads
.\tangle-guard-windows-x86_64.exe -d <your-repo-directory> ui

The above command starts the user interface and creates a configuration file in your repository. You can start configuring right away and add the config file into you repository.

For permanent use

Store the binary in a directory of your choice and eventually update your PATH.

Move the binary to the recommended location, which is /usr/local/bin.

cd Downloads/
sudo mv ./tangle-guard-macos-arm64 /usr/local/bin/tangle-guard

$HOME/.local/bin is recommended location by Linux standards.

If you use $HOME/.local/bin, make sure it’s in your PATH. If not, add it like below. How this need to be done depends on your shell.

# for Bash:
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
# for Zsh
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.zshrc
# for Fish
set -U fish_user_paths $HOME/.local/bin $fish_user_paths

If you just want the path in your current terminal session. This way, tangle-guard will not be available on restart or a different terminal session.

export PATH="$HOME/.local/bin:$PATH"

Common location would be C:\Users\<your-name>\bin.

Follow these steps to make the tool available globally from the terminal:

Add that folder to your PATH environment variable:

Press Win + S and search for “environment variables”
Click “Edit the system environment variables”
In the “System Properties” window, click “Environment Variables”
Under “User variables”, select the Path variable and click “Edit”
Click “New”, and enter the path to the folder where you placed the binary
Click OK to close all dialogs

If the help text is shown, the installation was successful.

To verify the installation, open a new terminal and paste the following in it.

tangle-guard --help

It the command shows you the available commands, the installation was a success.

End User License Agreement

This software is provided to you by the author (“Licensor”) free of charge for the purpose of testing, evaluation, and feedback. You are granted a non-exclusive, non-transferable, revocable license to use the software on your local machine.

You may use this software for testing and evaluation purposes within your organization.

The software is and remains the intellectual property of the Licensor. You receive no ownership rights through this license. Hence, you’re not allowed to modify or repackage the software.

This version of the software is in a public beta phase and may contain bugs, errors, or incomplete features. It is provided “as is” without warranty of any kind.

The Licensor reserves the right to terminate this license at any time. Upon termination, you must stop using the software.

This tool may communicate with the Licensor’s servers to verify license validity or beta period status. No personal data is collected.

This agreement shall be governed by the laws of Germany, without regard to its conflict of law principles.