go-proxy

README

CNTLM Proxy Configuration Tool

This project is a CLI for managing proxy configuring on a local dev machine. To configure CTNLM and other dev tools can be troublesome and time consuming.

This tool will be able to dynamically set proxy configuration within CNTLM and other supported tools that have tool specific proxy support.

Contents

• Installing
• Commands
• Getting Started
  • Prerequisites
  • Running Tests
  • Build And Package
• Built With
• Contributing
• Versioning
• Authors
• License
• Acknowledgments

Installing

Use the following to be able to install on MacOS via Homebrew:

Running the below command will add the homebrew tap to our repository

brew tap xUnholy/homebrew-proxy

Now you've added our custom tap, you can download with the following command:

brew install proxy

To upgrade your proxy to the latest stable release use the following command:

brew upgrade proxy

Note: Should the upgrade fail you may be required to remove the previous binary, the output will print what file to remove

Commands

The following is a list of all available commands:

• Start
• Stop
• Set
• Unset

Start

Usage example:

proxy start [command options] [arguments...]

OPTIONS:
   --port PORT, -p PORT  set custom CNTLM PORT (default: 3128)
   --all, -a             set all CNTLM config

Stop

Usage example:

proxy stop [command options] [arguments...]

OPTIONS:
   --all, -a  unset all CNTLM config

Set

Usage example:

proxy set command [command options] [arguments...]

Subcommand options:

COMMANDS:
     npm       set npm proxy config
     git       set git proxy config
     username  proxy set username
     password  proxy set password
     domain    proxy set domain

All subcommands have the following options:

OPTIONS:
   --port PORT, -p PORT  set custom CNTLM PORT (default: 3128)

To be able to set the CNTLM authentication password the password subcommand can be used. EG:

proxy set password

Once the password is entered and then encrypted, it will be stored in cntlm.conf.

Unset

Usage example:

proxy unset command [command options] [arguments...]

Subcommand options:

COMMANDS:
     npm  unset npm proxy config
     git  unset git proxy config

All subcommands have the following options:

OPTIONS:
   --port PORT, -p PORT  set custom CNTLM PORT (default: 3128)

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing.

Prerequisites

What things you need to install:

• golang

Running Tests

Use the following steps to execute the test suite:

go test -v  ./...

OR

make test

Note: The test suite will require you to have the supported tools installed and available locally.

Build And Package

To be able to package this tool, use one of the following below command:

go build -o proxy .

OR

make build

Once you have packaged the application the compiled binary can be executed with the following:

proxy [command options] [arguments...]

Built With

• golang - Programming Language
• urfave/cli - The CLI framework
• travis - Continuous Integration Tool
• vscode - IDE

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Michael Fornaro - Initial work - LinkedIn

See also the list of contributors who participated in this project.

License

This project is licensed under the GPL License - see the LICENSE.md file for details

Acknowledgments

Wish to acknowledge the following people for their inspiration, and guidance with this project and/or in general:

• Prateek Nayak - Github
• Jasper Brekelmans - Github