About embd-go tool

embd-go is an embeddable command-line tool for embedding data files in Go source code, specially crafted for easy use with go generate.

Easy use with go generate

The embd.go is a single, self-contained, MIT-licensed, go-runnable file, so you can copy it verbatim into your own project's repository, and keep it there forever:

         go get -d -u github.com/akavel/embd-go
Windows: copy %GOPATH%\src\github.com\akavel\embd-go\embd.go tools\embd.go
Linux:   cp $GOPATH/src/github.com/akavel/embd-go/embd.go tools/embd.go

and then call from e.g. go generate via go run, by putting a line like shown below in one of your Go source files:

//go:generate go run tools/embd.go -o embd/data.go -p embd MY_DATA/HELLO.DAT MY_DIRECTORY

Usage

USAGE: go run embd.go [FLAGS] PATH...
  -o="embd/data.go": Path to generated file.
  -p="embd": Package that the generated file should be in.

Note: directories that are used as a PATH will be added non-recursively (only immediate children)

Example

C:> go get github.com/akavel/embd-go
C:> echo Hello> hello.txt
C:> embd-go.exe -o hello.go -p main hello.txt
C:> type hello.go
// DO NOT EDIT BY HAND
//
// Generated with:
//
//      embd-go "-o" "hello.go" "-p" "main" "hello.txt"

package main

// File_hello_txt contains contents of "hello.txt" file.
var File_hello_txt = []byte("Hello\r\n")

Also, you could use directories as PATH. For example:

$ mkdir -p configs
$ echo 'config1' > configs/1.conf
$ echo 'config2' > configs/2.conf
$ ./embd-go -p "configs" configs
$ cat embd/data.go
// DO NOT EDIT BY HAND
//
// Generated with:
//
//	embd-go "-p" "configs" "configs"

package configs

var Dir_configs = struct {
	// File_1_conf contains contents of "configs/1.conf" file.
	File_1_conf []byte
	// File_2_conf contains contents of "configs/2.conf" file.
	File_2_conf []byte
}{
	[]byte("config1\n"),
	[]byte("config2\n"),
}