https://github.com/nmrshll/go-cp

Golang library to make copying files easy
https://github.com/nmrshll/go-cp

copy file go golang move

Last synced: about 1 year ago
JSON representation

Golang library to make copying files easy

• Host: GitHub
• URL: https://github.com/nmrshll/go-cp
• Owner: nmrshll
• License: mit
• Created: 2017-03-28T18:52:42.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2018-01-15T19:39:33.000Z (over 8 years ago)
• Last Synced: 2025-04-24T03:44:22.903Z (about 1 year ago)
• Topics: copy, file, go, golang, move
• Language: Go
• Homepage: https://godoc.org/github.com/nmrshll/go-cp
• Size: 7.81 KB
• Stars: 6
• Watchers: 2
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# go-cp

### Golang library to make copying files easy

Copying a file in vanilla Go forces you to deal with filesystem I/O, it's a bit overcomplicated for the general case, when you just want to copy a file as easy as using `cp $source $dest`.

This tiny, one-use-case library is just for that.

# Installation

Run `go get github.com/n-marshall/go-cp`.  

### Try it

In the repo folder run `make example`.  

# Usage

Simply use `cp.Copy(sourceFile, destinationFile)`.  

Full documentation found [here](https://godoc.org/github.com/nmrshll/go-cp)  

## Example

[embedmd]:# (./examples/example.go)

```go

package main

import (

	"log"

	cp "github.com/nmrshll/go-cp"

)

func main() {

	err := cp.CopyFile("examples/examplefile.ext", "examples/examplefile.copy.ext")

	if err != nil {

		log.Fatal(err)

	}

}

```

## Usage details

`CopyFile()` copies a file from src to dst. If src and dst files exist, and are

the same, then return success. Otherwise, attempt to create a hard link

between the two files. If that fails, copy the file contents from src to dst.  

Creates any missing directories.   

Supports '~' notation for $HOME directory of the current user.

`AbsolutePath()` converts a path (relative or absolute) into an absolute one.  

Supports '~' notation for $HOME directory of the current user.