serialStripper

command module
v1.0.0 Latest Latest
Warning

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

Go to latest
Published: Sep 7, 2024 License: MIT Imports: 5 Imported by: 0

README

SerialStripper

SerialStripper is a simple CLI tool designed to process serial numbers from a text file, format them into a comma-separated list, and save the result in a new text file. It will also convert the formatted list into a PDF file.

Features

  • Reads serial numbers from a text file (one serial number per line).
  • Converts the list into a single line of comma-separated values.
  • Saves the result into a new text file.
  • Converts the text file into a PDF document.

Usage

1. Install the Tool

You can install SerialStripper using go install:

go install github.com/stilyanpetrovv/serialStripper@latest

Installing from Source

To build and install SerialStripper from source, follow these steps:

Prerequisites
  • Go (version 1.18 or higher) must be installed on your system. Verify installation with go version.
Steps
  1. Clone the Repository

    git clone https://github.com/myacc/serialStripper.git
    cd serialStripper
    
  2. Build the project

go build -o serialStripper
  1. Install the Binary
go install

This installs the binary to your $GOPATH/bin directory.

Packages

This project uses the following external packages:

  • gofpdf: A PDF generation library for Go. Used for converting the formatted serial numbers into a PDF document.

To install the required packages, run:

go mod tidy

Running the Tool

You must name the file containing the serial numbers "serial_numbers.txt" otherwise it will throw an error and exit.

Considering you installed via go install you can use

./serialStripper

License

This project is licensed under the MIT License. See the LICENSE file for details.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

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