Cloudpods

https://github.com/yunionio/cloudpods
Admin
Cloudpods is an open-source, Golang-based platform for unified multi/hybrid-cloud management,...
Tokens:184,747
Snippets:1,239
Trust Score:9.9
License:Apache-2.0
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install and Run Go OLE Example

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/go-ole/go-ole/README.md

Instructions to install the Go OLE library and run its example program. This involves fetching the library, navigating to its directory, running tests, and executing a specific example.

```Shell
go get github.com/go-ole/go-ole
cd /path/to/go-ole/
go test

cd /path/to/go-ole/example/excel
go run excel.go
```

--------------------------------

### Create a Basic Gin Web Server

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/gin-gonic/gin/README.md

A complete Go program demonstrating how to initialize a Gin router, define a GET endpoint, and start the server. This example serves a 'pong' message on the '/ping' route.

```go
package main

import "github.com/gin-gonic/gin"

func main() {
	r := gin.Default()
	r.GET("/ping", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "pong"
		})
	})
	r.Run() // listen and serve on 0.0.0.0:8080 (for windows "localhost:8080")
}
```

--------------------------------

### Install and Use gxz Command Line Utility

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/ulikunitz/xz/README.md

Instructions for installing the `gxz` command-line tool using `go get` and examples for compressing and decompressing files from the terminal. This utility provides command-line access to xz compression functionalities.

```shell
go get github.com/ulikunitz/xz/cmd/gxz
gxz bigfile
gxz -d bigfile.xz
```

--------------------------------

### Install utfbom Go Package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/dimchansky/utfbom/README.md

Use the `go get` command to download and install the `utfbom` package and its dependencies.

```Shell
go get -u github.com/dimchansky/utfbom
```

--------------------------------

### Install Go DHT Library and Commands

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/anacrolix/dht/README.md

Instructions to install the `dht` library package and its associated command-line tools using the `go get` command. This fetches the source code and installs the binaries.

```Shell
go get github.com/anacrolix/dht
```

```Shell
go get github.com/anacrolix/dht/cmd/...
```

--------------------------------

### Install Objx Go Package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/stretchr/objx/README.md

Provides the `go get` command to install the Objx library for Go projects.

```Go
go get github.com/stretchr/objx
```

--------------------------------

### Install Go Color Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/fatih/color/README.md

This snippet shows how to install the `fatih/color` Go package using the `go get` command. This command fetches the package from its repository and installs it into your Go workspace, making it available for use in your projects.

```bash
go get github.com/fatih/color
```

--------------------------------

### Install Go Bitset Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/willf/bitset/README.md

Command to install the `bitset` library for Go using `go get`.

```Bash
go get github.com/willf/bitset
```

--------------------------------

### Install Go logging library using go get

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/op/go-logging/README.md

Command to download and install the `go-logging` package into your Go workspace. Use `-u` to update an existing installation.

```Shell
$ go get github.com/op/go-logging
```

--------------------------------

### Install Go-MySQL-Driver using go get

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/go-sql-driver/mysql/README.md

Instructions to install the Go-MySQL-Driver package into your GOPATH using the `go get` command. This command fetches the latest version of the driver from its repository. Requires Git to be installed and in the system's PATH.

```bash
go get -u github.com/go-sql-driver/mysql
```

--------------------------------

### Install and Test Go Netlink Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/vishvananda/netlink/README.md

This section provides commands to set up the Go netlink library development environment. It includes `go get` commands for installing the main library and its testing dependencies, followed by the command to execute tests. Note that running tests requires elevated root privileges.

```shell
go get github.com/vishvananda/netlink
go get github.com/vishvananda/netns
sudo -E go test github.com/vishvananda/netlink
```

--------------------------------

### Install Mergo Go Library and Import

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/imdario/mergo/README.md

Instructions for installing the Mergo library using `go get` and importing it into a Go project for use.

```Go
go get github.com/imdario/mergo

    // use in your .go code
    import (
        "github.com/imdario/mergo"
    )
```

--------------------------------

### Install OpenCensus Go Library via go get

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/go.opencensus.io/README.md

This command installs the OpenCensus Go library using the `go get` tool. It fetches the latest version of the `go.opencensus.io` package and its dependencies. This is the recommended first step to integrate OpenCensus into a Go application for performance monitoring.

```Shell
go get -u go.opencensus.io
```

--------------------------------

### Install bbolt Go library and CLI

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/go.etcd.io/bbolt/README.md

Commands to install the bbolt Go library into your Go module cache and its command-line utility using `go get`, `go run`, and `go install`.

```sh
go get go.etcd.io/bbolt@latest
```

```sh
go run go.etcd.io/bbolt/cmd/bbolt@latest
```

```sh
go install go.etcd.io/bbolt/cmd/bbolt@latest
```

--------------------------------

### Install bazil.org/fuse Go Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/bazil.org/fuse/README.md

Command to download and install the `bazil.org/fuse` Go library using the `go get` tool. This command fetches the library and its dependencies, making it available for use in Go projects.

```Go
go get bazil.org/fuse
```

--------------------------------

### Install otgrpc Go Package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/grpc-ecosystem/grpc-opentracing/go/otgrpc/README.md

Instructions to install the `otgrpc` package, which provides OpenTracing support for gRPC in Go, using the `go get` command.

```Go
go get github.com/grpc-ecosystem/grpc-opentracing/go/otgrpc
```

--------------------------------

### Run Project Tests

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/go.opencensus.io/CONTRIBUTING.md

Commands to install necessary build tools (required only for the first time setup) and then execute the project's test suite using Make. This ensures your changes do not introduce regressions.

```bash
$ make install-tools  # Only first time.
$ make
```

--------------------------------

### Install Go Universal Translator Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/go-playground/universal-translator/README.md

Instructions to install the `universal-translator` Go library using the `go get` command, which fetches the package from its repository.

```shell
go get github.com/go-playground/universal-translator
```

--------------------------------

### Install go-daemon Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/sevlyar/go-daemon/README.md

Instructions for installing the `go-daemon` library using the `go get` command. It provides options for both the direct GitHub repository and a versioned `gopkg.in` path. For production environments, using vendoring is advised to ensure stability.

```Shell
go get github.com/sevlyar/go-daemon
```

```Shell
go get gopkg.in/sevlyar/go-daemon.v0
```

--------------------------------

### Install Go signedxml package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/ma314smith/signedxml/README.md

Instructions to install the signedxml Go package using the `go get` command.

```Go
go get github.com/ma314smith/signedxml
```

--------------------------------

### Install Go Client Library for IAM API

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/cloud.google.com/go/iam/README.md

Instructions to install the Go client library for the IAM API using the `go get` command. This command fetches and installs the specified Go package and its dependencies.

```bash
go get cloud.google.com/go/iam
```

--------------------------------

### Install Go LZ4 Package and CLI Tool

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/pierrec/lz4/README.md

Commands to install the `lz4` Go package and its command-line interface tool `lz4c` using `go get` and `go install`.

```Go
go get github.com/pierrec/lz4
```

```Go
go install github.com/pierrec/lz4/cmd/lz4c
```

--------------------------------

### Install Gin Framework using Go Get

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/gin-gonic/gin/README.md

Command to download and install the Gin web framework package using Go's package manager. Requires Go version 1.13+.

```sh
$ go get -u github.com/gin-gonic/gin
```

--------------------------------

### Install durafmt Go Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/hako/durafmt/README.md

Command to install the durafmt Go library using `go get`.

```Go
go get github.com/hako/durafmt
```

--------------------------------

### Install Go Semantic Versioning Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/blang/semver/README.md

Instructions to install the `blang/semver` library using the `go get` command. It is recommended to vendor dependencies or fix to a specific version tag for production use.

```bash
go get github.com/blang/semver
```

--------------------------------

### Install gorilla/mux Go Module

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/gorilla/mux/README.md

Instructions to install the gorilla/mux Go module using the `go get` command. This command fetches the latest version of the library and adds it to your Go workspace.

```sh
go get -u github.com/gorilla/mux
```

--------------------------------

### Install OpenTracing-go Observer Package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/opentracing-contrib/go-observer/README.md

Instructions to fetch the `go-observer` package using the `go get` command, which is necessary to use the observer API for OpenTracing-go. This command downloads and installs the package into your Go workspace.

```Go
go get -v github.com/opentracing-contrib/go-observer
```

--------------------------------

### Install Excelize Go Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/xuri/excelize/v2/README.md

Instructions for installing the Excelize Go library. The first command is for general installation, and the second is specifically for projects using Go Modules, ensuring the correct version is pulled.

```bash
go get github.com/xuri/excelize
```

```bash
go get github.com/xuri/excelize/v2
```

--------------------------------

### Create a Complete Go HTTP Server with Gorilla Mux

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/gorilla/mux/README.md

This comprehensive Go example provides a full, runnable implementation of a basic HTTP server built with `gorilla/mux`. It defines a simple handler (`YourHandler`) and configures the router to serve it at the root path, demonstrating a minimal yet functional web application setup.

```Go
package main

import (
    "net/http"
    "log"
    "github.com/gorilla/mux"
)

func YourHandler(w http.ResponseWriter, r *http.Request) {
    w.Write([]byte("Gorilla!\n"))
}

func main() {
    r := mux.NewRouter()
    // Routes consist of a path and a handler function.
    r.HandleFunc("/", YourHandler)

    // Bind to a port and pass our router in
    log.Fatal(http.ListenAndServe(":8000", r))
}
```

--------------------------------

### Install go-tty Go Package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/mattn/go-tty/README.md

This command line snippet provides the standard method for installing the `go-tty` library into your Go development environment using the `go get` tool.

```bash
go get github.com/mattn/go-tty
```

--------------------------------

### Install Go Set Package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/gopkg.in/fatih/set.v0/README.md

Instructions for installing the `fatih/set` Go package using `go get` and importing it into a Go project.

```Bash
go get github.com/fatih/set
```

```Go
import "githug.com/fatih/set"
```

--------------------------------

### Run Tests with Docker Compose

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/ClickHouse/clickhouse-go/CONTRIBUTING.md

This snippet demonstrates how to start Docker Compose services and then execute the 'make' command, typically used for running tests or building the project. It assumes Docker Compose is installed and configured.

```shell
docker-compose up
make
```

--------------------------------

### Install Zap Go Logging Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/go.uber.org/zap/README.md

Command to install the Zap logging library for Go projects using `go get`.

```Go
go get -u go.uber.org/zap
```

--------------------------------

### Install GoUtils Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/aokoli/goutils/README.md

Instructions for installing the GoUtils library using the standard Go package manager. This command fetches and installs the library into your Go workspace.

```Go
go get github.com/Masterminds/goutils
```

--------------------------------

### Install etcd clientv3 Go package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/go.etcd.io/etcd/client/v3/README.md

Commands to install the etcd clientv3 Go package using `go get`, including a pre-release version for etcd 3.5.0.

```bash
go get go.etcd.io/etcd/client/v3
```

```bash
go get go.etcd.io/etcd/client/v3@v3.5.0-pre
```

--------------------------------

### Install go-metrics Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/rcrowley/go-metrics/README.md

Provides instructions for installing the core `go-metrics` library using the Go package manager. This command fetches and installs the necessary packages to begin using the metrics functionality.

```Shell
go get github.com/rcrowley/go-metrics
```

--------------------------------

### Install Go ANSI Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/mgutz/ansi/README.md

Use `go get` to download and install the `mgutz/ansi` package, making it available for use in Go projects.

```sh
go get -u github.com/mgutz/ansi
```

--------------------------------

### Download torrents using the `torrent` command-line tool

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/anacrolix/torrent/README.md

This example demonstrates how to install and use the `torrent` command-line utility to download a file from a magnet link. It shows the download progress and verifies the integrity of the downloaded file using `md5sum`.

```Shell
$ go get github.com/anacrolix/torrent/cmd/torrent
# Now 'torrent' should be in $GOPATH/bin, which should be in $PATH.
$ torrent 'magnet:?xt=urn:btih:KRWPCX3SJUM4IMM4YF5RPHL6ANPYTQPU'
ubuntu-14.04.2-desktop-amd64.iso [===================================================================>]  99% downloading (1.0 GB/1.0 GB)
2015/04/01 02:08:20 main.go:137: downloaded ALL the torrents
$ md5sum ubuntu-14.04.2-desktop-amd64.iso
1b305d585b1918f297164add46784116  ubuntu-14.04.2-desktop-amd64.iso
$ echo such amaze
wow
```

--------------------------------

### Install go-socket.io package using go get

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/googollee/go-socket.io/README.md

This snippet shows how to install the go-socket.io library using the standard Go package manager. It fetches the library from its GitHub repository.

```Bash
go get github.com/googollee/go-socket.io
```

--------------------------------

### Correct Go Import Path and Installation for Zap

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/go.uber.org/zap/FAQ.md

Explains the correct import path for the `go.uber.org/zap` library, emphasizing the use of `go get -u go.uber.org/zap` for installation and `import "go.uber.org/zap"` in Go code, rather than `github.com/uber-go/zap`.

```Go
// Install the library
go get -u go.uber.org/zap

// In your Go code, import Zap
import "go.uber.org/zap"
```

--------------------------------

### Install Go OAuth2 Package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/golang.org/x/oauth2/README.md

Command to install the official Go OAuth2 client library using the `go get` tool. This fetches the package and its dependencies into your Go workspace.

```Shell
go get golang.org/x/oauth2
```

--------------------------------

### Install go-engine.io package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/googollee/go-engine.io/README.md

Instructions to install the go-engine.io library using the Go package manager. This command fetches the repository and installs it into your Go workspace.

```bash
go get github.com/googollee/go-engine.io
```

--------------------------------

### Verify Examples Build After Release

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/go.opentelemetry.io/otel/RELEASING.md

This script verifies that examples build correctly outside of the repository after a release. It copies examples, removes `replace` declarations in `go.mod`, and builds them to ensure compatibility with the published release.

```Shell
./verify_examples.sh
```

--------------------------------

### Install Go Roaring Bitmap Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/RoaringBitmap/roaring/README.md

Instructions to install the Go version of the Roaring bitmap library, including its dependencies, using the `go get` command.

```Go
go get -t github.com/RoaringBitmap/roaring
```

--------------------------------

### Install go-qrcode library and CLI tool

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/skip2/go-qrcode/README.md

Use the `go get` command to download and install the `go-qrcode` package and its associated command-line utility into your Go workspace.

```Shell
go get -u github.com/skip2/go-qrcode/...
```

--------------------------------

### Basic go-engine.io server example

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/googollee/go-engine.io/README.md

A complete Go example showcasing how to set up a basic engine.io server. It demonstrates accepting client connections, handling incoming text and binary messages, sending responses, and integrating with the standard Go HTTP server to serve the engine.io endpoint.

```go
package main

import (
	"encoding/hex"
	"io/ioutil"
	"log"
	"net/http"

	"github.com/googollee/go-engine.io"
)

func main() {
	server, err := engineio.NewServer(nil)
	if err != nil {
		log.Fatal(err)
	}

	go func() {
		for {
			conn, _ := server.Accept()
			go func() {
				defer conn.Close()
				for i := 0; i < 10; i++ {
					t, r, _ := conn.NextReader()
					b, _ := ioutil.ReadAll(r)
					r.Close()
					if t == engineio.MessageText {
						log.Println(t, string(b))
					} else {
						log.Println(t, hex.EncodeToString(b))
					}
					w, _ := conn.NextWriter(t)
					w.Write([]byte("pong"))
					w.Close()
				}
			}()
		}
	}()

	http.Handle("/engine.io/", server)
	http.Handle("/", http.FileServer(http.Dir("./asset")))
	log.Println("Serving at localhost:5000...")
	log.Fatal(http.ListenAndServe(":5000", nil))
}
```

--------------------------------

### Build and Install Go DNS Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/miekg/dns/README.md

Instructions for building and installing the `miekg/dns` library using the standard Go toolchain. This involves fetching the source code and compiling it.

```Go
go get github.com/miekg/dns
go build github.com/miekg/dns
```

--------------------------------

### Install Go Protobuf and gRPC Code Generation Plugins

Source: https://github.com/yunionio/cloudpods/blob/master/pkg/hostman/hostdeployer/Readme.md

Commands to install `protoc-gen-go-grpc` and `protoc-gen-go` using `go install`. These plugins are crucial for the `protoc` compiler to generate Go-specific code from Protocol Buffer definitions, especially for gRPC service interfaces and messages.

```Shell
$ protoc --version
libprotoc 3.21.5
$ GOPROXY=direct go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2
$ GOPROXY=direct go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28
```

--------------------------------

### Install and Run Local Go Documentation Site

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/go.opentelemetry.io/otel/CONTRIBUTING.md

Instructions to install and run a local Go documentation server using the `pkgsite` tool, which allows for browsing Go packages and their documentation locally.

```Shell
go install golang.org/x/pkgsite/cmd/pkgsite@latest
pkgsite
```

--------------------------------

### Configure Gin with Basic http.ListenAndServe

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/gin-gonic/gin/README.md

Shows how to run a Gin router using the standard Go `http.ListenAndServe()` function, providing a simple way to start the server.

```go
func main() {
	router := gin.Default()
	http.ListenAndServe(":8080", router)
}
```

--------------------------------

### Install Go pty package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/creack/pty/README.md

Instructions to install the `github.com/creack/pty` Go package using the `go get` command.

```Shell
go get github.com/creack/pty
```

--------------------------------

### SQL Examples for SQLite User Authentication Management

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/mattn/go-sqlite3/README.md

Provides practical SQL examples demonstrating how to use the user management functions. Includes examples for adding an administrator user, changing a user's password, and deleting a user from the database.

```SQL
SELECT auth_user_add('admin2', 'admin2', 1);
SELECT auth_user_change('user', 'userpassword', 0);
SELECT user_delete('user');
```

--------------------------------

### Install uitable Go Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/gosuri/uitable/README.md

This command uses `go get` to download and install the `uitable` library from its GitHub repository. The `-v` flag provides verbose output during the installation process.

```sh
go get -v github.com/gosuri/uitable
```

--------------------------------

### Install Go UUID Package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/google/uuid/README.md

Use the `go get` command to download and install the `github.com/google/uuid` package into your Go workspace.

```Shell
go get github.com/google/uuid
```

--------------------------------

### Install go-httpheader Go Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/mozillazg/go-httpheader/README.md

Use the Go package manager to download and install the go-httpheader library.

```Go
go get -u github.com/mozillazg/go-httpheader
```

--------------------------------

### Setup Zap Repository for Contribution

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/go.uber.org/zap/CONTRIBUTING.md

This snippet outlines the initial steps to set up the 'zap' Go repository for development. It involves creating the necessary directory structure, cloning your forked repository, and configuring the upstream remote to fetch updates from the main repository.

```bash
mkdir -p $GOPATH/src/go.uber.org
cd $GOPATH/src/go.uber.org
git clone git@github.com:your_github_username/zap.git
cd zap
git remote add upstream https://github.com/uber-go/zap.git
git fetch upstream
```

--------------------------------

### Install Go multierr Package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/go.uber.org/multierr/README.md

Command to install the `multierr` Go package using the `go get` tool. This command fetches the package from its repository and installs it into your Go workspace.

```Go
go get -u go.uber.org/multierr
```

--------------------------------

### Install Go YAML package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/go-yaml/yaml/README.md

Instructions to install the `gopkg.in/yaml.v2` package using the `go get` command.

```Go
go get gopkg.in/yaml.v2
```

--------------------------------

### Install Go Bloom Filter Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/willf/bloom/README.md

Provides the command to install the 'willf/bloom' Go package using 'go get'.

```Bash
go get -u github.com/willf/bloom
```

--------------------------------

### Install Go netns Package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/vishvananda/netns/README.md

Command to fetch and install the 'netns' Go package using 'go get'.

```Shell
go get github.com/vishvananda/netns
```

--------------------------------

### Set up GoPacket development environment and run local checks

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/google/gopacket/CONTRIBUTING.md

Instructions for setting up the gopacket development environment, including cloning the repository, creating a new feature branch, and running local pre-commit checks using the `gc` script to ensure code quality before submitting a pull request.

```Shell
go get github.com/google/gopacket
cd $GOROOT/src/pkg/github.com/google/gopacket
git checkout -b <mynewfeature>  # create a new branch to work from
... code code code ...
./gc  # Run this to do local commits, it performs a number of checks
```

--------------------------------

### Install Bolt Go Key/Value Store via go get

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/boltdb/bolt/README.md

This shell command uses `go get` to retrieve the Bolt library and install the `bolt` command-line utility into the user's `$GOBIN` path, making it available for use in Go projects.

```Shell
go get github.com/boltdb/bolt/...
```

--------------------------------

### Install sigs.k8s.io/yaml Go module

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/sigs.k8s.io/yaml/README.md

Instructions to install the `sigs.k8s.io/yaml` Go module using the `go get` command.

```Shell
go get sigs.k8s.io/yaml
```

--------------------------------

### Install Gofrs UUID Package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/gofrs/uuid/README.md

Instructions on how to install the `gofrs/uuid` package using the `go get` command. This method is suitable when not using a dependency manager.

```Shell
go get github.com/gofrs/uuid
```

--------------------------------

### Example Go Build Command with Multiple SQLite Features

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/mattn/go-sqlite3/README.md

Demonstrates how to use the `go build` command with multiple space-delimited build tags to enable several SQLite features like ICU, JSON1, FTS5, and secure delete.

```bash
go build -tags "icu json1 fts5 secure_delete"
```

--------------------------------

### Go ZFS Filesystem, Snapshot, and Clone Management

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/mistifyio/go-zfs/README.md

This Go code snippet demonstrates fundamental ZFS operations using the `go-zfs` wrapper. It illustrates the creation of a ZFS filesystem, followed by taking a snapshot of it, cloning the snapshot, and finally, destroying the cloned filesystem, the snapshot, and the original filesystem. The example assumes a pre-existing ZFS zpool named 'test' and omits detailed error handling for brevity.

```Go
//assuming a zpool named test
//error handling omitted

f, err := zfs.CreateFilesystem("test/snapshot-test", nil)
ok(t, err)

s, err := f.Snapshot("test", nil)
ok(t, err)

// snapshot is named "test/snapshot-test@test"

c, err := s.Clone("test/clone-test", nil)

err := c.Destroy()
err := s.Destroy()
err := f.Destroy()
```

--------------------------------

### Install fsnotify and create a feature branch

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/fsnotify/fsnotify/CONTRIBUTING.md

Instructions for installing the fsnotify project using `go get` and creating a new Git feature branch for development.

```Shell
go get -u github.com/fsnotify/fsnotify
```

```Shell
git checkout -b my-new-feature
```

--------------------------------

### Create Database Examples (InfluxQL)

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/influxdata/influxql/README.md

Examples demonstrating how to create a database with default settings, and how to specify a custom default retention policy with duration, replication, and shard group duration upon database creation.

```SQL
-- Create a database called foo
CREATE DATABASE "foo"

-- Create a database called bar with a new DEFAULT retention policy and specify the duration, replication, shard group duration, and name of that retention policy
CREATE DATABASE "bar" WITH DURATION 1d REPLICATION 1 SHARD DURATION 30m NAME "myrp"

-- Create a database called mydb with a new DEFAULT retention policy and specify the name of that retention policy
CREATE DATABASE "mydb" WITH NAME "myrp"
```

--------------------------------

### Basic glog Logging Examples

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/k8s.io/klog/v2/README.md

Demonstrates fundamental logging operations using the glog library, including informational messages, fatal error handling, and V-level logging for verbosity control.

```Go
glog.Info("Prepare to repel boarders")
```

```Go
glog.Fatalf("Initialization failed: %s", err)
```

```Go
if glog.V(2) {
	glog.Info("Starting transaction...")
}
```

```Go
glog.V(2).Infoln("Processed", nItems, "elements")
```

--------------------------------

### Install Go YAML Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/ghodss/yaml/README.md

Instructions to install the `ghodss/yaml` Go package using `go get` and how to import it into a Go project.

```Shell
go get github.com/ghodss/yaml
```

```Go
import "github.com/ghodss/yaml"
```

--------------------------------

### Build Caddy from Source

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/mholt/caddy/README.md

Instructions to build the Caddy web server from its source code. This process requires Git and Go (version 1.9 or newer) installed on the system. The `build.go` script compiles the Caddy binary, which should then be added to the system's PATH.

```Shell
go get github.com/mholt/caddy/caddy
go get github.com/caddyserver/builds
cd $GOPATH/src/github.com/mholt/caddy/caddy
go run build.go
```

--------------------------------

### Install Go Bencode Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/anacrolix/torrent/bencode/README.md

Instructions to install the `anacrolix/torrent` Go library, which includes the bencode subpackage, using the `go get` command.

```Shell
go get github.com/anacrolix/torrent
```

--------------------------------

### Install App Engine Legacy Migration Tool (aefix)

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/google.golang.org/appengine/README.md

Instructions to install the "aefix" command-line tool, which assists in automating the upgrade process from legacy "appengine" packages to the new "google.golang.org/appengine" import paths.

```bash
go get google.golang.org/appengine/cmd/aefix
```

--------------------------------

### Install go-pinyin Go Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/mozillazg/go-pinyin/README.md

Installs the `go-pinyin` library for Chinese Pinyin conversion into your Go workspace using the `go get` command.

```Go
go get -u github.com/mozillazg/go-pinyin
```

--------------------------------

### CoreDNS File Plugin Example: Multiple Zones from Single File

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/coredns/coredns/plugin/file/README.md

Example configuration demonstrating how to use a single zone file ('example.org.signed') to serve multiple zones ('example.org', 'example.net'). The '.' block signifies that the configuration applies to all zones. It also includes transfer options to the internet and a specific IP address.

```Corefile
. {
    file example.org.signed example.org example.net {
        transfer to *
        transfer to 10.240.1.1
    }
}
```

--------------------------------

### Install goxml2json package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/basgys/goxml2json/README.md

Command to install the goxml2json Go package using `go get -u`. This fetches the latest version of the library and makes it available for use in Go projects.

```Shell
go get -u github.com/basgys/goxml2json
```

--------------------------------

### Bolt Database Initialization: Open()

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/go.etcd.io/bbolt/README.md

Initializes the database, creating it if it doesn't exist. It obtains an exclusive file lock, reads meta pages, and memory-maps the file, setting up the database for operations.

```APIDOC
Open():
  - Initializes database
  - Creates database if not exists
  - Obtains exclusive file lock
  - Reads meta pages
  - Memory-maps the file
```

--------------------------------

### Install `go.uber.org/atomic` Go Package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/go.uber.org/atomic/README.md

This command installs the `go.uber.org/atomic` package at version `v1` using `go get`, ensuring the correct module is fetched for your Go project.

```shell
$ go get -u go.uber.org/atomic@v1
```

--------------------------------

### Go ClickHouse Basic CRUD Operations

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/ClickHouse/clickhouse-go/README.md

This Go snippet demonstrates fundamental interactions with a ClickHouse database. It includes establishing a connection, pinging the database, creating a table, inserting multiple records using a prepared statement, querying data, and finally dropping the table. Error handling for ClickHouse-specific exceptions is also shown.

```go
package main

import (
	"database/sql"
	"fmt"
	"log"
	"time"

	"github.com/ClickHouse/clickhouse-go"
)

func main() {
	connect, err := sql.Open("clickhouse", "tcp://127.0.0.1:9000?debug=true")
	if err != nil {
		log.Fatal(err)
	}
	if err := connect.Ping(); err != nil {
		if exception, ok := err.(*clickhouse.Exception); ok {
			fmt.Printf("[%d] %s \n%s\n", exception.Code, exception.Message, exception.StackTrace)
		} else {
			fmt.Println(err)
		}
		return
	}

	_, err = connect.Exec(`
		CREATE TABLE IF NOT EXISTS example (
			country_code FixedString(2),
			os_id        UInt8,
			browser_id   UInt8,
			categories   Array(Int16),
			action_day   Date,
			action_time  DateTime
		) engine=Memory
	`)

	if err != nil {
		log.Fatal(err)
	}
	var (
		tx, _   = connect.Begin()
		stmt, _ = tx.Prepare("INSERT INTO example (country_code, os_id, browser_id, categories, action_day, action_time) VALUES (?, ?, ?, ?, ?, ?)")
	)
	defer stmt.Close()

	for i := 0; i < 100; i++ {
		if _, err := stmt.Exec(
			"RU",
			10+i,
			100+i,
			clickhouse.Array([]int16{1, 2, 3}),
			time.Now(),
			time.Now(),
		); err != nil {
			log.Fatal(err)
		}
	}

	if err := tx.Commit(); err != nil {
		log.Fatal(err)
	}

	rows, err := connect.Query("SELECT country_code, os_id, browser_id, categories, action_day, action_time FROM example")
	if err != nil {
		log.Fatal(err)
	}
	defer rows.Close()

	for rows.Next() {
		var (
			country               string
			os, browser           uint8
			categories            []int16
			actionDay, actionTime time.Time
		)
		if err := rows.Scan(&country, &os, &browser, &categories, &actionDay, &actionTime); err != nil {
			log.Fatal(err)
		}
		log.Printf("country: %s, os: %d, browser: %d, categories: %v, action_day: %s, action_time: %s", country, os, browser, categories, actionDay, actionTime)
	}

	if err := rows.Err(); err != nil {
		log.Fatal(err)
	}

	if _, err := connect.Exec("DROP TABLE example"); err != nil {
		log.Fatal(err)
	}
}
```

--------------------------------

### Install Go-Playground Locales Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/go-playground/locales/README.md

Use the `go get` command to download and install the `go-playground/locales` package into your Go workspace. This command fetches the latest version of the library and its dependencies.

```shell
go get github.com/go-playground/locales
```

--------------------------------

### Initialize and Register Basic Routes with gorilla/mux

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/gorilla/mux/README.md

Demonstrates how to create a new `mux.Router`, register simple URL paths to handlers, and integrate it with the standard `http.Handle`. This sets up the fundamental routing mechanism for your web application.

```Go
func main() {
    r := mux.NewRouter()
    r.HandleFunc("/", HomeHandler)
    r.HandleFunc("/products", ProductsHandler)
    r.HandleFunc("/articles", ArticlesHandler)
    http.Handle("/", r)
}
```

--------------------------------

### Resolve go get compilation errors for go-sqlite3

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/mattn/go-sqlite3/README.md

Provides a solution for 'internal compiler error' during `go get` for go-sqlite3. Recommends removing the existing repository and using `go install` for a clean re-installation.

```bash
go install github.com/mattn/go-sqlite3
```

--------------------------------

### Install Go ADAL Package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/Azure/go-autorest/autorest/adal/README.md

Instructions to install the `autorest/adal` package for Go using `go get`. This package provides functionalities for Azure Active Directory authentication.

```bash
go get -u github.com/Azure/go-autorest/autorest/adal
```

--------------------------------

### Serve Files from Local Path or File System with Gin

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/gin-gonic/gin/README.md

Explains how to serve files directly from the local file system using c.File, or from an abstract http.FileSystem interface using c.FileFromFS, providing flexibility in file sourcing.

```go
func main() {
	router := gin.Default()

	router.GET("/local/file", func(c *gin.Context) {
		c.File("local/file.go")
	})

	var fs http.FileSystem = // ...
	router.GET("/fs/file", func(c *gin.Context) {
		c.FileFromFS("fs/file.go", fs)
	})
}
```

--------------------------------

### Install Gomail with Go Get (Legacy)

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/gopkg.in/mail.v2/README.md

This snippet provides the "go get" import path for the Gomail library, specifically for projects not using vendoring and relying on the Gopkg.in versioning system.

```Go
gopkg.in/mail.v2
```

--------------------------------

### Install and Update oglematchers Go Package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/smartystreets/assertions/internal/oglematchers/README.md

Instructions for installing the `oglematchers` Go package using the `go get` command. This command also ensures the package is updated to its latest version.

```Shell
go get -u github.com/smartystreets/assertions/internal/oglematchers
```

--------------------------------

### Install Go INI Package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/gopkg.in/ini.v1/README.md

Installs the `ini` package for Go using the `go get` command. This package provides INI file read and write functionality and requires Go version 1.6 or higher.

```Shell
$ go get gopkg.in/ini.v1
```

--------------------------------

### Install Go UUID Package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/satori/go.uuid/README.md

Use the `go get` command to download and install the `github.com/satori/go.uuid` package into your Go workspace. This command fetches the package and its dependencies, making it available for use in your Go projects.

```Bash
go get github.com/satori/go.uuid
```

--------------------------------

### Go ANSI Basic Colorization Examples

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/mgutz/ansi/README.md

Illustrates core functionalities of the `ansi` package, including direct string coloring with `ansi.Color`, creating optimized color functions with `ansi.ColorFunc`, and manual construction of colored output using `ansi.ColorCode`.

```go
import "github.com/mgutz/ansi"

// colorize a string, SLOW
msg := ansi.Color("foo", "red+b:white")

// create a FAST closure function to avoid computation of ANSI code
phosphorize := ansi.ColorFunc("green+h:black")
msg = phosphorize("Bring back the 80s!")
msg2 := phospohorize("Look, I'm a CRT!")

// cache escape codes and build strings manually
lime := ansi.ColorCode("green+h:black")
reset := ansi.ColorCode("reset")

fmt.Println(lime, "Bring back the 80s!", reset)
```

--------------------------------

### Install Go mscfb Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/richardlehane/mscfb/README.md

Use the `go get` command to download and install the `mscfb` library for parsing Microsoft Compound File Binary Format files.

```Go
go get github.com/richardlehane/mscfb
```

--------------------------------

### Compress and Decompress Text with Go xz Package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/ulikunitz/xz/README.md

Demonstrates basic compression of a string and subsequent decompression using the `xz` Go package. It shows how to initialize `xz.NewWriter` to compress data into a buffer and `xz.NewReader` to decompress from the buffer to standard output.

```go
package main

import (
    "bytes"
    "io"
    "log"
    "os"

    "github.com/ulikunitz/xz"
)

func main() {
    const text = "The quick brown fox jumps over the lazy dog.\n"
    var buf bytes.Buffer
    // compress text
    w, err := xz.NewWriter(&buf)
    if err != nil {
        log.Fatalf("xz.NewWriter error %s", err)
    }
    if _, err := io.WriteString(w, text); err != nil {
        log.Fatalf("WriteString error %s", err)
    }
    if err := w.Close(); err != nil {
        log.Fatalf("w.Close error %s", err)
    }
    // decompress buffer and write output to stdout
    r, err := xz.NewReader(&buf)
    if err != nil {
        log.Fatalf("NewReader error %s", err)
    }
    if _, err = io.Copy(os.Stdout, r); err != nil {
        log.Fatalf("io.Copy error %s", err)
    }
}
```

--------------------------------

### Set Up Git Pre-push Hook for Automated Testing

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/gopkg.in/ldap.v3/README.md

Command to create a symbolic link that configures a Git pre-push hook, automatically running tests and verification scripts before code is pushed to a remote repository.

```Shell
ln -s ../../.githooks/pre-push .git/hooks/pre-push
```

--------------------------------

### Install ClickHouse Go Driver via go get

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/ClickHouse/clickhouse-go/README.md

Command-line instruction to install the ClickHouse Go driver using the Go module system. This fetches the latest version of the driver from its GitHub repository.

```sh
go get -u github.com/ClickHouse/clickhouse-go
```

--------------------------------

### Create User Examples (InfluxQL)

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/influxdata/influxql/README.md

Examples for creating users in InfluxDB. This includes creating a normal database user and an administrative user with all privileges.

```SQL
-- Create a normal database user.
CREATE USER "jdoe" WITH PASSWORD '1337password'

-- Create an admin user.
-- Note: Unlike the GRANT statement, the "PRIVILEGES" keyword is required here.
CREATE USER "jdoe" WITH PASSWORD '1337password' WITH ALL PRIVILEGES
```

--------------------------------

### Set up a basic Gin web server with a /ping endpoint

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/gin-gonic/gin/README.md

This Go code defines a simple Gin web application. It sets up a router with a '/ping' GET endpoint that responds with 'pong'. This snippet demonstrates the fundamental structure for a Gin application.

```go
package main

func setupRouter() *gin.Engine {
	r := gin.Default()
	r.GET("/ping", func(c *gin.Context) {
		c.String(200, "pong")
	})
	return r
}

func main() {
	r := setupRouter()
	r.Run(":8080")
}
```

--------------------------------

### Install Go Google Cloud Compute Metadata Library

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/cloud.google.com/go/compute/metadata/README.md

This command installs the Google Cloud Compute Metadata Go library using `go get`. It fetches the necessary packages for interacting with the Google Cloud metadata service.

```Bash
go get cloud.google.com/go/compute/metadata
```

--------------------------------

### Install Go native package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/josharian/native/readme.md

This command installs the `native` Go package from GitHub. It uses the standard Go module management tool, `go get`, to fetch and add the package to your project's dependencies.

```Shell
go get github.com/josharian/native
```

--------------------------------

### Install go-colorable Go package

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/mattn/go-colorable/README.md

This command installs the `go-colorable` package using the Go module system, making it available for use in Go projects. It fetches the package from its GitHub repository.

```Shell
go get github.com/mattn/go-colorable
```

--------------------------------

### Go Mux: Serving Static Files

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/gorilla/mux/README.md

Provides a complete example of setting up a Gorilla Mux router to serve static files from a specified directory. It includes server configuration with timeouts, demonstrating a common use case for `PathPrefix`.

```go
func main() {
    var dir string

    flag.StringVar(&dir, "dir", ".", "the directory to serve files from. Defaults to the current dir")
    flag.Parse()
    r := mux.NewRouter()

    // This will serve files under http://localhost:8000/static/<filename>
    r.PathPrefix("/static/").Handler(http.StripPrefix("/static/", http.FileServer(http.Dir(dir))))

    srv := &http.Server{
        Handler:      r,
        Addr:         "127.0.0.1:8000",
        // Good practice: enforce timeouts for servers you create!
        WriteTimeout: 15 * time.Second,
        ReadTimeout:  15 * time.Second,
    }

    log.Fatal(srv.ListenAndServe())
}
```

--------------------------------

### Install Dameng Go Driver via Go Get

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/gitee.com/chunanyong/dm/README.md

Use this command to install the official Dameng database Go driver from Gitee. This driver is synchronized with the official Dameng versions, ensuring compatibility and ease of use with Go modules.

```Go
go get gitee.com/chunanyong/dm
```

--------------------------------

### Create a Blank Gin Router (Go)

Source: https://github.com/yunionio/cloudpods/blob/master/vendor/github.com/gin-gonic/gin/README.md

Shows how to initialize a Gin router using `gin.New()`, which creates an instance without any default middleware (like Logger or Recovery) attached. This provides a minimal setup for custom configurations.

```go
r := gin.New()
```
Tokens:
Raw