https://github.com/go-git/go-billy
The missing interface filesystem abstraction for Go
https://github.com/go-git/go-billy
Last synced: 6 months ago
JSON representation
The missing interface filesystem abstraction for Go
- Host: GitHub
- URL: https://github.com/go-git/go-billy
- Owner: go-git
- License: apache-2.0
- Created: 2020-03-09T18:35:04.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2025-06-03T09:53:50.000Z (6 months ago)
- Last Synced: 2025-06-16T03:32:29.326Z (6 months ago)
- Language: Go
- Homepage: https://pkg.go.dev/github.com/go-git/go-billy/v5
- Size: 491 KB
- Stars: 353
- Watchers: 7
- Forks: 48
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-billy [](https://pkg.go.dev/github.com/go-git/go-billy/v6) [](https://github.com/go-git/go-billy/actions?query=workflow%3ATest) [](https://scorecard.dev/viewer/?uri=github.com/go-git/go-billy)
The missing interface filesystem abstraction for Go.
Billy implements an interface based on the `os` standard library, allowing to develop applications without dependency on the underlying storage. Makes it virtually free to implement mocks and testing over filesystem operations.
Billy was born as part of [go-git/go-git](https://github.com/go-git/go-git) project.
## Installation
```go
import "github.com/go-git/go-billy/v6" // with go modules enabled (GO111MODULE=on or outside GOPATH)
import "github.com/go-git/go-billy" // with go modules disabled
```
## Usage
Billy exposes filesystems using the
[`Filesystem` interface](https://pkg.go.dev/github.com/go-git/go-billy/v6?tab=doc#Filesystem).
Each filesystem implementation gives you a `New` method, whose arguments depend on
the implementation itself, that returns a new `Filesystem`.
The following example caches in memory all readable files in a directory from any
billy's filesystem implementation.
```go
func LoadToMemory(origin billy.Filesystem, path string) (*memory.Memory, error) {
memory := memory.New()
files, err := origin.ReadDir("/")
if err != nil {
return nil, err
}
for _, file := range files {
if file.IsDir() {
continue
}
src, err := origin.Open(file.Name())
if err != nil {
return nil, err
}
dst, err := memory.Create(file.Name())
if err != nil {
return nil, err
}
if _, err = io.Copy(dst, src); err != nil {
return nil, err
}
if err := dst.Close(); err != nil {
return nil, err
}
if err := src.Close(); err != nil {
return nil, err
}
}
return memory, nil
}
```
## Why billy?
The library billy deals with storage systems and Billy is the name of a well-known, IKEA
bookcase. That's it.
## License
Apache License Version 2.0, see [LICENSE](LICENSE)