README.md

Mole

Mole is a cli application to create ssh tunnels focused on resiliency and user experience.

For more information about installation, usage, examples and specific use cases, please visit https://davrodpin.github.io/mole/

How to build from source

Go 1.17.1+ is required to be installed on your system to build this project.

$ make build

How to run tests

$ make test

How to generate a code coverage report

$ make cover && open coverage.html

How to run static analysis

1. Install golangci-lint

2. Run the following command

$ make lint

Test Environment

The project provides a small automated infrastructure to help with manual testing Please refer to this document for more details about it.

How to Contribute

Please refere to CONTRIBUTING.md for details on how to contribute to this project.