netcat

command module
v0.0.0-...-a5dac7b Latest Latest
Warning

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

Go to latest
Published: Nov 22, 2024 License: MIT Imports: 4 Imported by: 0

README

netcat

This project consists on recreating the netcat in a server-client architecture that can run in a server mode on a specified port listening for incoming connections, and it can be used in client mode, trying to connect to a specified port and transmitting information to the server.

Prerequisites

  • Go programming language version 1.22 and above.

  • Basic understanding of TCP.

Installation

  • Clone the repository from the remote location to your local environment and switch to the project's directory using the below terminal command.
    git clone https://github.com/johneliud/netcat.git
    cd netcat
    

Usage

  • Run the program from the root using either of the below terminal commands.

    go run .
    
    go run . [SPECIFY-PORT]
    

NOTE: The program uses port 8989 as its default port using the first run command. A success message is displayed if the program succeeds to run.

  • Open a new terminal session and paste the below command to access the program using netcat's server.
nc localhost [SPECIFIED-PORT]

Example

  1. Run the program's server

  1. Switch to new terminal sessions and access the program using netcat's server.

Contributions

Contributions towards improving the project are welcome. Feel free to create a new branch and submit a pull request or create issues on how to improve the project.

Creating a branch
  • git checkout -b feat-improvement-your_name
    
  • git add modified_file
    
  • git commit -m "description_of_your_changes"
    
  • git push --set-upstream origin feat-improvement-your_name
    

Contact

Incase of further enquiries, do not hesitate to reach out.

Credits and Acknowledgements

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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