Skip to content

Latest commit

 

History

History
70 lines (50 loc) · 1.73 KB

README.md

File metadata and controls

70 lines (50 loc) · 1.73 KB

Banner

Snoop : Share files easily.

Snoop is a CLI tool created with golang using cobra, which helps in transfering files among devices that are connected to the same network.

Table of Contents

Local Development Setup

To set up the project for local development, follow these steps:

  1. Clone the repository:

    git clone https://github.com/deepraj02/snoop.git
cd snoop

  2. Install dependencies: Ensure you have Go installed. Then, run:

    go mod download

  3. Build the project:

    make build

  4. Run the project:

    make run

Installation

Note: Working on releasing the binary directly to package repos like Choco (windows), apt-get (Linux), as of now for these platform you can download the zip/tar.gz files.

For a step-by-step installation process for all OS, refer to INSTALLATION.md.

How to Use

Share Page

  1. Navigate to the directory you want to share:

    cd /path/to/your/directory

  2. Start the server:

    snoop serve

    By default, the server will start on port 8080. You can specify a different port using the -p or --port flag:

    snoop serve -p 9090

  3. Access the server: Open your web browser and navigate to http://your-local-ip:8080 (or the port you specified).

  4. Download files: Click on the file links to download them.