npck

README

Supported formats • Installation • Usage example • CI Status • License

npck is a Go package for unpacking various types of archives.

Supported formats

• tar (.tar)
• Gzip (.gz, .tgz, .tar.gz)
• bzip2 (.bz2, .tbz2, .tar.bz2)
• xz (.xz, .txz, .tar.xz)
• Zstandart (.zst, .tzst, .tar.zst)
• LZ4 (.lz4, .tlz4, .tar.lz4)
• ZIP (.zip)

Installation

Make sure you have a working Go 1.18+ workspace (instructions), then:

go get -u github.com/essentialkaos/npck

Usage example

package main

import (
  "fmt"
  "github.com/essentialkaos/npck"
)

func main() {
  file := "file.tar.gz"
  err := npck.Unpack(file, "/home/john")

  if err != nil {
    fmt.Printf("Error: Can't unpack %s: %v\n", file, err)
    return
  }

  fmt.Printf("File %s successfully unpacked!\n", file)
}

CI Status

Branch	Status
master
develop

License

Apache License, Version 2.0

Documentation

Overview

Package npck provides methods for unpacking various types of archives

Index

• Variables
• func Unpack(file, dir string) error

Examples

• Unpack

Variables

var ErrUnsupportedFormat = fmt.Errorf("Unknown or unsupported archive type")

Functions

func Unpack

func Unpack(file, dir string) error

Unpack unpacks given file

Example

file := "file.tzg"
err := Unpack(file, "/home/bob/data")

if err != nil {
	fmt.Printf("Error: Can't unpack %s: %v\n", file, err)
	return
}

fmt.Printf("File %s successfully unpacked!\n", file)