mole

command module
v2.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 1, 2021 License: MIT Imports: 2 Imported by: 0

README

CI Documentation

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.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
Package alias provides utility functions related to alias configuration file management.
Package alias provides utility functions related to alias configuration file management.
Package cmd implements all commands supported by Mole through CLI.
Package cmd implements all commands supported by Mole through CLI.
Package fsutils provides utility functions to manage mole related files and directories.
Package fsutils provides utility functions to manage mole related files and directories.
Package tunnel provides APIs to create SSH tunnels to perform local port forwarding, leveraging the SSH configuration file (e.g.
Package tunnel provides APIs to create SSH tunnels to perform local port forwarding, leveraging the SSH configuration file (e.g.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL