Warden

The RepoWarden CLI warden is a tool to audit your git repositories based on policy. Check the default branch, license, and labels across multiple repositories across multiple organizations.

Warden is very early stage right now with limited features.

Table of Contents

• Compatibility
• Installation
  • Linux
  • macOS
  • Windows
• Configuring
• Features

Compatibility

Operating Systems

Designed to work on Linux, macOS, and Windows computers.

VCS Providers

GitHub is supported. GitLab support is on the roadmap.

Installation

Linux

There are a few ways you can install Warden on a Linux amd64 or arm64 system.

Ubuntu Apt Repository (recommended)

I (Ricardo N Feliciano) run an Apt/Debian repository for a lot of my software, which includes Warden. The benefit of the Apt repository is that updates are handled by Ubuntu's built-in package manager.

For security reasons, first we install the GPG key for the repository:

sudo wget "http://pkg.feliciano.tech/ftech-archive-keyring.gpg" -P /usr/share/keyrings/

Now we add the repository to the system:

echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/ftech-archive-keyring.gpg] http://pkg.feliciano.tech/ubuntu $(lsb_release -sc) main" | sudo tee /etc/apt/sources.list.d/felicianotech.list

Finally, we can install Warden:

sudo apt update && sudo apt install warden

Debian Package (.deb)

You can install warden on an Debian/Apt based computer by downloading the .deb file to the desired system.

For graphical systems, you can download it from the GitHub Releases page. Many distros allow you to double-click the file to install. Via terminal, you can do the following:

wget https://github.com/repowarden/cli/releases/download/v0.5.1/warden-v0.5.1-amd64.deb
sudo dpkg -i warden-v0.5.1-amd64.deb

0.1.0 and amd64 may need to be replaced with your desired version and CPU architecture respectively.

Binary Install

You can download and run the raw warden binary from the GitHub Releases page if you don't want to use any package manager. Simply download the tarball for your OS and architecture and extract the binary to somewhere in your PATH. Here's one way to do this with curl and tar:

dlURL="https://github.com/repowarden/cli/releases/download/v0.5.1/warden-v0.5.1-linux-amd64.tar.gz"
curl -sSL $dlURL | sudo tar -xz -C /usr/local/bin warden

0.5.1 and amd64 may need to be replaced with your desired version and CPU architecture respectively.

macOS

There are two ways you can install warden on a macOS system.

Brew (recommended)

Installing Warden via brew is a simple one-liner:

brew install repowarden/tap/warden

Binary Install

You can download and run the raw warden binary from the GitHub Releases page if you don't want to use any package manager. Simply download the tarball for your OS and architecture and extract the binary to somewhere in your PATH. Here's one way to do this with curl and tar:

curl -sSL "https://github.com/repowarden/cli/releases/download/v0.5.1/warden-v0.5.1-macos-amd64.tar.gz" | sudo tar -xz -C /usr/local/bin warden

0.5.1 and amd64 may need to be replaced with your desired version and CPU architecture respectively.

Windows

Warden supports Windows 10 by downloading and installing the binary. Chocolately support is likely coming in the future. If there's a Windows package manager you'd like support for (including Chocolately), please open and Issue and ask for it.

Binary Install (exe)

You can download and run the warden executable from the GitHub Releases page. Simply download the zip for architecture and extract the exe.

Configuring

credentials - the credentials file is ~/.config/warden/creds.yaml. The key githubToken should be set to a token that has enough permissions to do what you need.

policies - the policy file, policy.yml, should be in the current directory. You can get started by copying over the example one: cp example.policy.yml policy.yml

Features

Currently warden can audit the following items:

• license
• labels
• default branch
• codeowners
• access permissions (for teams only right now)

Run warden help to see all commands available.

License

This repository is licensed under the MIT license. The license can be found here.