GoWebDAV

https://github.com/studio-b12/gowebdav
Admin
GoWebDAV is a pure Go WebDAV client library that enables developers to interact with remote WebDAV...
Tokens:61,111
Snippets:575
Trust Score:8.1
License:BSD-3-Clause
Update:4 weeks ago
Show doc for...
Tokens:
Raw
### Install gowebdav with go get

Source: https://github.com/studio-b12/gowebdav/blob/master/cmd/gowebdav/README.md

Install the gowebdav command-line tool using 'go get'. Requires Go 1.x and Git 2.14.2 or higher.

```sh
go get -u github.com/studio-b12/gowebdav/cmd/gowebdav

```

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

### NewClient usage example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

Example usage of NewClient with a root WebDAV URL, user, and password. Returns a *Client that never fails.

```go
c := gowebdav.NewClient("https://webdav.example.com", "user", "secret")
```

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

### Use as os.FileInfo

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/file.md

Example of using a File as os.FileInfo in any os-compatible slot, such as with fmt.Println.

```go
info, _ := c.Stat("docs/file.txt")
fmt.Println(info.Mode(), info.Size(), info.ModTime()) // FileInfo accessors
```

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

### Copy usage example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

Example usage of the Copy method. Copies docs/a.txt to docs/a-copy.txt with overwrite disabled.

```go
if err := c.Copy("docs/a.txt", "docs/a-copy.txt", false); err != nil {
    log.Fatal(err)
}
```

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

### Read usage example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

Example usage of the Read method. Reads the entire file into memory and writes it to a local file.

```go
data, err := c.Read("docs/file.txt")
if err != nil {
    log.Fatal(err)
}
os.WriteFile("/tmp/file.txt", data, 0644)
```

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

### Write usage example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

Example usage of the Write method. Uploads a byte slice to docs/hello.txt. Returns nil on 200/201/204 (including after the retry); NewPathError("Write", path, s) otherwise.

```go
if err := c.Write("docs/hello.txt", []byte("Hello WebDAV"), 0644); err != nil {
    log.Fatal(err)
}
```

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

### Usage Examples

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/passportAuth.md

Usage examples for Passport authentication in gowebdav.

```APIDOC
## Automatic Negotiation

### Description
Registers `basic`, `digest`, and `passport1.4` authenticators in `NewAutoAuth`. Passport is chosen when the server challenges with a `Passport1.4` header that neither Basic nor Digest matches.

### Example
```go
c := gowebdav.NewClient("https://webdav.example.com", "me@example.com", "pw")
if err := c.Connect(); err != nil {
    log.Fatal(err) // no matching authenticator -> NewPathError("NoAuthenticator", ...)
}
data, err := c.Read("Shared Documents/report.xlsx")
```

```

```APIDOC
## Manual Construction with Explicit Challenge Capture

### Description
Manually constructs a PassportAuth instance by capturing the initial `401` challenge, useful for load-balanced or multi-tenant setups.

### Example
```go
rs, err := http.Get("https://webdav.example.com/") // returns 401 with Passport1.4 challenge
if err == nil && rs.StatusCode == http.StatusUnauthorized {
    auth, err := gowebdav.NewPassportAuth(http.DefaultClient, "me@example.com", "pw",
        rs.Request.URL.String(), &rs.Header)
    if err != nil {
        log.Fatal(err) // sign-in failure: PathError("Authorize", "/", status)
    }
    az := gowebdav.NewPreemptiveAuth(auth)
    c := gowebdav.NewAuthClient("https://webdav.example.com", az)
    // c is now authenticated with the harvested cookies
}
```

```

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

### Wrapper script usage examples

Source: https://github.com/studio-b12/gowebdav/blob/master/cmd/gowebdav/README.md

Examples of using the dav wrapper script to list, upload, stat, and download files.

```sh
$ ./dav -X LS /

$ echo hi dav! > hello && ./dav -X PUT /hello
$ ./dav -X STAT /hello
$ ./dav -X PUT /hello_dav hello
$ ./dav -X GET /hello_dav
$ ./dav -X GET /hello_dav hello.txt

```

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

### NewPreemptiveAuth usage example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/auth.md

Creates a preemptive authorizer with BasicAuth and a client using it.

```go
az := gowebdav.NewPreemptiveAuth(&gowebdav.BasicAuth{})
c := gowebdav.NewAuthClient("https://webdav.example.com", az)
```

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

### ReadConfig usage example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/utils.md

Demonstrates reading credentials from a netrc file for a given URI, returning the login and password.

```go
// ~/.netrc:  machine webdav.example.com login alice password s3cret
u, p := gowebdav.ReadConfig("https://webdav.example.com/", filepath.Join(home, ".netrc"))
// u == "alice", p == "s3cret"
```

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

### Create a directory with c.Mkdir()

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Creates a single directory on the WebDAV server. The example omits error checks for brevity, but production code should handle them.

```go
err := c.Mkdir("folder", 0644)
```

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

### NewAutoAuth usage example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/auth.md

Creates a client with auto authentication using the provided credentials.

```go
c := gowebdav.NewAuthClient("https://webdav.example.com", gowebdav.NewAutoAuth("admin", "s3cret"))
```

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

### NewAuthClient usage example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

Example usage of NewAuthClient with a preemptive BasicAuth authorizer. Creates a custom authorizer and passes it to the constructor.

```go
auth := gowebdav.NewPreemptiveAuth(&gowebdav.BasicAuth{})
c := gowebdav.NewAuthClient("https://webdav.example.com", auth)
```

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

### Rename usage example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

Example usage of the Rename method. Moves docs/a.txt to docs/b.txt with overwrite enabled. Returns nil for 201/204; NewPathError(method, oldpath, s) for other statuses.

```go
if err := c.Rename("docs/a.txt", "docs/b.txt", true); err != nil {
    log.Fatal(err)
}
```

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

### Create a gowebdav Client with NewClient()

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Creates a gowebdav Client instance with the given root URL, user, and password, then connects. The example omits error checks for brevity, but production code should handle them.

```go
root := "https://webdav.mydomain.me"
user := "user"
password := "password"

c := gowebdav.NewClient(root, user, password)
c.Connect()
// kick of your work!
```

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

### Auto-negotiated usage example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/basicAuth.md

Uses NewClient with credentials; the 'basic' factory wins if Basic is offered after a 401 challenge.

```go
c := gowebdav.NewClient("https://webdav.example.com", "user", "pw")
_ = c.Connect() // server challenges, "basic" factory wins if Basic is offered
```

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

### Get file information with c.Stat()

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Gets information about a specified file or folder using c.Stat(). The returned info has os.FileInfo type. The example omits error checks for brevity, but production code should handle them.

```go
webdavFilePath := "folder/subfolder/file.txt"

info := c.Stat(webdavFilePath)
//notice that [info] has os.FileInfo type
fmt.Println(info)
```

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

### Join usage example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/utils.md

Demonstrates joining a base URL with a path, ensuring a single slash separator.

```go
gowebdav.Join("https://host/", "docs/a.txt") // "https://host/docs/a.txt"
```

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

### String usage example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/utils.md

Shows how to use String to read from a strings.Reader, returning the content as a string.

```go
gowebdav.String(strings.NewReader("abc")) // "abc"
```

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

### List directory contents with c.ReadDir()

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Lists the contents of a directory on the WebDAV server. Each returned file has os.FileInfo type, and the example prints each file name. The example omits error checks for brevity, but production code should handle them.

```go
files, _ := c.ReadDir("folder/subfolder")
for _, file := range files {
    //notice that [file] has os.FileInfo type
    fmt.Println(file.Name())
}
```

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

### Create multiple directories with c.MkdirAll()

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Creates several folders at once, including intermediate ones, using c.MkdirAll(). The example omits error checks for brevity, but production code should handle them.

```go
err := c.MkdirAll("folder/subfolder/subfolder2", 0644)
```

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

### NewEmptyAuth usage example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/auth.md

Creates an empty authorizer, adds a custom authenticator, and creates a client with it.

```go
az := gowebdav.NewEmptyAuth()
az.AddAuthenticator("custom", func(c *http.Client, rs *http.Response, path string) (gowebdav.Authenticator, error) {
    return &MyTokenAuth{token: myTokenFrom(rs)}, nil
})
c := gowebdav.NewAuthClient("https://webdav.example.com", az)
```

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

### Iterate directory listing

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/file.md

Example of iterating over the results of Client.ReadDir, printing directory and file information.

```go
files, err := c.ReadDir("docs")
if err != nil {
    log.Fatal(err)
}
for _, f := range files {
    if f.IsDir() {
        fmt.Println("DIR ", f.Name(), "->", f.Path())
    } else {
        fmt.Println("FILE", f.Name(), f.Size(), f.ModTime(), f.ETag())
    }
}
```

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

### Stat: Get file metadata

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

Stat returns metadata for a single file or folder via PROPFIND with Depth: 0. Returns a *File with populated fields or nil on error. The example shows checking for not-found errors and printing size and modification time.

```go
func (c *Client) Stat(path string) (os.FileInfo, error)
```

```go
info, err := c.Stat("docs/file.txt")
if err != nil {
    if gowebdav.IsErrNotFound(err) {
        fmt.Println("not found")
    }
}
fmt.Println(info.Size(), info.ModTime())
```

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

### netrc file example and usage

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/configuration.md

Shows the netrc file format and a command-line usage example. The netrc file contains a machine entry with login and password. The command uses the -root flag and -X LS to list the directory, and relies on the netrc file for credentials when PASSWORD is unset.

```sh
# ~/.netrc
machine webdav.example.com login alice password s3cret

```

```sh
# Usage: PASSWORD unset -> credentials pulled from the netrc file
gowebdav -root https://webdav.example.com -X LS docs

```

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

### Environment-configured gowebdav usage examples

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/cli.md

Shows environment-variable configuration for the gowebdav CLI and several common operations: listing, downloading, uploading, creating directories, moving, and deleting. Requires ROOT, USER, and PASSWORD environment variables.

```sh
export ROOT=https://webdav.example.com USER=alice PASSWORD=s3cret
gowebdav -X LS docs
gowebdav -X GET docs/file.txt /tmp/file.txt
gowebdav -X PUT uploads/file.txt docs/file.txt
gowebdav -X MKDIRALL a/b/c
gowebdav -X MV docs/a.txt docs/b.txt
gowebdav -X DEL docs/b.txt
```

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

### WriteStream usage example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

Example usage of WriteStream. Opens a local file and uploads it to the remote path "uploads/upload.bin" with mode 0644. The file is seekable, so the content length is determined by seeking.

```go
f, err := os.Open("/tmp/upload.bin")
if err != nil {
    log.Fatal(err)
}
defer f.Close()
if err := c.WriteStream("uploads/upload.bin", f, 0644); err != nil {
    log.Fatal(err)
}
```

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

### FixSlashes usage examples

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/utils.md

Shows FixSlashes normalizing paths to have both leading and trailing slashes.

```go
gowebdav.FixSlashes("docs")    // "/docs/"
gowebdav.FixSlashes("/a/b")    // "/a/b/"
```

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

### ReadStream usage example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

Example usage of the ReadStream method. Streams a file and copies it to a destination file, closing the reader with defer.

```go
rc, err := c.ReadStream("docs/big.bin")
if err != nil {
    log.Fatal(err)
}
defer rc.Close()
n, err := io.Copy(dstFile, rc)
```

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

### Authorize usage example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/basicAuth.md

Shows calling Authorize on a bare &BasicAuth{} instance. Since fields are unexported, credentials are empty, but the header is still set.

```go
var rq http.Request
b := &gowebdav.BasicAuth{}
_ = b.Authorize(http.DefaultClient, &rq, "/") // rq.Header now contains Authorization
```

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

### PathEscape usage example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/utils.md

Shows how to call PathEscape with a path containing spaces and plus signs, producing the escaped output.

```go
gowebdav.PathEscape("a b/c+d") // "a%20b/c%2Bd"
```

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

### Preemptive usage example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/basicAuth.md

Uses NewPreemptiveAuth with an empty &BasicAuth{} to avoid a 401 round trip. The authorizer is documented as goroutine-safe for this case.

```go
c := gowebdav.NewAuthClient("https://webdav.example.com", gowebdav.NewPreemptiveAuth(&gowebdav.BasicAuth{}))
_ = c.Connect()
```

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

### Download file to byte array with c.Read()

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Downloads a file from the WebDAV server into a byte array and writes it to a local file. The example omits error checks for brevity, but production code should handle them.

```go
webdavFilePath := "folder/subfolder/file.txt"
localFilePath := "/tmp/webdav/file.txt"

bytes, _ := c.Read(webdavFilePath)
os.WriteFile(localFilePath, bytes, 0644)
```

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

### Custom factory usage example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/basicAuth.md

Shows a custom factory that returns &BasicAuth{} with empty credentials. Note that this instance has empty credentials; populate through NewAutoAuth or implement a custom Authenticator if credentials are required.

```go
az := gowebdav.NewEmptyAuth()
az.AddAuthenticator("basic", func(_ *http.Client, _ *http.Response, _ string) (gowebdav.Authenticator, error) {
    return &gowebdav.BasicAuth{}, nil
})
c := gowebdav.NewAuthClient("https://webdav.example.com", az)
if _, err := c.Read("secret.txt"); err != nil {
    // gowebdav.IsErrCode(err, 401) == true
}
```

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

### WriteStreamWithLength usage example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

Example usage of WriteStreamWithLength. Uploads a bytes.Buffer containing "hello" to "docs/h.txt" with an explicit content length. The content length is provided by the caller, so no seek or buffering is performed.

```go
data := bytes.NewBufferString("hello")
if err := c.WriteStreamWithLength("docs/h.txt", data, int64(data.Len()), 0644); err != nil {
    log.Fatal(err)
}
```

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

### Connect: Verify server reachability

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

Connect sends an OPTIONS request with Depth: 0 to verify server reachability. Returns nil on success, otherwise a *os.PathError with op "Connect". The example shows creating a client and handling a connection error.

```go
func (c *Client) Connect() error
```

```go
c := gowebdav.NewClient("https://webdav.example.com", "user", "pw")
if err := c.Connect(); err != nil {
    log.Fatal(err) // &os.PathError{Op: "Connect", Path: "https://webdav.example.com/", Err: StatusError{...}}
}
```

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

### Copy file (MV as copy)

Source: https://github.com/studio-b12/gowebdav/blob/master/cmd/gowebdav/README.md

Copy a file to another location on the remote server. The example uses MV, but the intent is to copy.

```sh
gowebdav -X MV temp/file.txt temp/file-copy.txt

```

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

### FixSlash usage examples

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/utils.md

Demonstrates FixSlash on URLs with and without a trailing slash, both resulting in a single trailing slash.

```go
gowebdav.FixSlash("https://host")  // "https://host/"
gowebdav.FixSlash("https://host/") // "https://host/"
```

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

### Configure gowebdav Client with setters

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/configuration.md

Shows how to create a gowebdav client and apply common behavioral setters: SetTimeout, SetTransport, SetHeader, and SetInterceptor. The interceptor logs the HTTP method and URL for every request after authorization. This is the only code example on the page.

```go
c := gowebdav.NewClient("https://webdav.example.com", "u", "p")
c.SetTimeout(30 * time.Second)
c.SetTransport(&http.Transport{Proxy: http.ProxyFromEnvironment})
c.SetHeader("User-Agent", "myapp/1.0")
c.SetInterceptor(func(method string, rq *http.Request) { log.Println(method, rq.URL) })
```

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

### Manual construction with explicit challenge capture

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/passportAuth.md

For load-balanced or multi-tenant setups, manually capture the Passport1.4 challenge from a 401 response and construct a PassportAuth with NewPassportAuth. Then wrap it with NewPreemptiveAuth and create an authenticated client.

```go
rs, err := http.Get("https://webdav.example.com/") // returns 401 with Passport1.4 challenge
if err == nil && rs.StatusCode == http.StatusUnauthorized {
    auth, err := gowebdav.NewPassportAuth(http.DefaultClient, "me@example.com", "pw",
        rs.Request.URL.String(), &rs.Header)
    if err != nil {
        log.Fatal(err) // sign-in failure: PathError("Authorize", "/", status)
    }
    az := gowebdav.NewPreemptiveAuth(auth)
    c := gowebdav.NewAuthClient("https://webdav.example.com", az)
    // c is now authenticated with the harvested cookies
}
```

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

### Upload file with known length using c.WriteStreamWithLength()

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Uploads a file via a writer with a known length using c.WriteStreamWithLength(). The example omits error checks for brevity, but production code should handle them.

```go
webdavFilePath := "folder/subfolder/file.txt"

bytes := []byte{0x20, 0x20}

c.WriteStreamWithLength(webdavFilePath, bytes.NewBuffer(bytes), int64(len(data)), 0644)
```

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

### Download file via reader with c.ReadStream()

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Downloads a file from the WebDAV server via a reader using c.ReadStream(), then copies the stream to a local file. The example omits error checks for brevity, but production code should handle them.

```go
webdavFilePath := "folder/subfolder/file.txt"
localFilePath := "/tmp/webdav/file.txt"

reader, _ := c.ReadStream(webdavFilePath)

file, _ := os.Create(localFilePath)
defer file.Close()

io.Copy(file, reader)
```

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

### Download file (GET)

Source: https://github.com/studio-b12/gowebdav/blob/master/cmd/gowebdav/README.md

Download a file from the remote server to a local path. Target local path is optional; if omitted, the file is saved to the current directory.

```sh
gowebdav -X GET temp/document.rtf /tmp/webdav/document.rtf

```

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

### Create DigestAuth from challenge response

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/digestAuth.md

Example of creating a DigestAuth instance from a challenge response. The http.Get call retrieves the challenge, and NewDigestAuth returns nil, nil.

```go
rs, _ := http.Get("https://webdav.example.com/")            // challenge response
auth, err := gowebdav.NewDigestAuth("user", "pw", rs)       // returns nil, nil
```

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

### Copy file with c.Copy()

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Copies a file to another location on the WebDAV server using c.Copy(). The isOverwrite flag controls whether to overwrite an existing file. The example omits error checks for brevity, but production code should handle them.

```go
oldPath := "folder/subfolder/file.txt"
newPath := "folder/subfolder/file-copy.txt"
isOverwrite := true

c.Copy(oldPath, newPath, isOverwrite)
```

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

### Upload file from byte array with c.Write()

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Uploads a file from a local byte array to the WebDAV server using c.Write(). The example omits error checks for brevity, but production code should handle them.

```go
webdavFilePath := "folder/subfolder/file.txt"
localFilePath := "/tmp/webdav/file.txt"

bytes, _ := os.ReadFile(localFilePath)

c.Write(webdavFilePath, bytes, 0644)
```

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

### Delete file with c.Remove()

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Deletes a file on the WebDAV server using c.Remove(). The example omits error checks for brevity, but production code should handle them.

```go
webdavFilePath := "folder/subfolder/file.txt"

c.Remove(webdavFilePath)
```

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

### Verify a response for staleness

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/digestAuth.md

Example of calling Verify on a response. It returns redo true when the server says stale=true; normally the Client's request loop calls this, not consumer code.

```go
rs2, _ := http.Post("https://webdav.example.com/file", "application/octet-stream", body)
redo, err := auth.Verify(http.DefaultClient, rs2, "/file")
// redo == true when the server says stale=true; consumer code normally never calls this directly —
// the Client's request loop does.
```

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

### Verify error comment example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/basicAuth.md

Illustrates the error returned by Verify on a 401 response: &os.PathError{Op: "Authorize", Path: <path>, Err: StatusError{401}}.

```go
// With a plain BasicAuth authenticator, a 401 becomes:
//   &os.PathError{Op: "Authorize", Path: <path>, Err: StatusError{401}}
```

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

### Mkdir: Create a collection

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

Mkdir creates a single remote collection via MKCOL. A 405 response is treated as success. Returns nil on 201, otherwise a *os.PathError. The example shows creating a directory and handling errors.

```go
func (c *Client) Mkdir(path string, _ os.FileMode) (err error)
```

```go
if err := c.Mkdir("docs/new", 0755); err != nil {
    log.Fatal(err)
}
```

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

### Client.Mkdir method

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Creates a directory at the specified path.

```go
func (c *Client) Mkdir(path string, _ os.FileMode) (err error)
```

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

### ReadDir: List directory contents

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

ReadDir lists immediate children of a directory via PROPFIND with Depth: 1. Returns []os.FileInfo or *os.PathError. The example shows listing a directory and iterating over the results.

```go
func (c *Client) ReadDir(path string) ([]os.FileInfo, error)
```

```go
files, err := c.ReadDir("docs")
if err != nil {
    log.Fatal(err)
}
for _, f := range files {
    fmt.Println(f.Name()) // os.FileInfo interface
}
```

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

### SetJar: Set cookie jar for client

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

SetJar sets a cookie jar so cookies are stored and sent across requests. The example creates a new cookie jar and assigns it to the client.

```go
func (c *Client) SetJar(jar http.CookieJar)
```

```go
jar, _ := cookiejar.New(nil)
c.SetJar(jar)
```

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

### File.Sys method

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Returns system-specific information (documented as '????').

```go
func (f File) Sys() interface{}
```

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

### Upload file via writer with c.WriteStream()

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Uploads a file via a writer using c.WriteStream(). For non-seekable streams, this reads data into memory first to discover content length. The example omits error checks for brevity, but production code should handle them.

```go
webdavFilePath := "folder/subfolder/file.txt"
localFilePath := "/tmp/webdav/file.txt"

file, _ := os.Open(localFilePath)
defer file.Close()

c.WriteStream(webdavFilePath, file, 0644)
```

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

### Move file with c.Rename()

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Moves a file to another location on the WebDAV server using c.Rename(). The isOverwrite flag controls whether to overwrite an existing file. The example omits error checks for brevity, but production code should handle them.

```go
oldPath := "folder/subfolder/file.txt"
newPath := "folder/subfolder/moved.txt"
isOverwrite := true

c.Rename(oldPath, newPath, isOverwrite)
```

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

### MkdirAll: Create nested directories

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

MkdirAll creates the full path hierarchy like mkdir -p. On a 409 conflict it iterates each path segment and MKCOLs missing intermediates. Returns nil on success, otherwise a *os.PathError. The example shows creating a nested directory structure.

```go
func (c *Client) MkdirAll(path string, _ os.FileMode) (err error)
```

```go
if err := c.MkdirAll("a/b/c/d", 0755); err != nil {
    log.Fatal(err)
}
```

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

### ReadStreamRange usage example

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

Example usage of the ReadStreamRange method. Reads bytes 1024 through 3071 of a file. On 200 (server ignored the range) the first offset bytes are discarded and the body is wrapped in a limitedReadCloser that caps reads at length bytes.

```go
rc, err := c.ReadStreamRange("docs/big.bin", 1024, 2048) // bytes 1024..3071
if err != nil {
    log.Fatal(err)
}
defer rc.Close()
```

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

### MkdirAll method

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Creates a directory and all parent directories, similar to mkdir -p, for WebDAV.

```go
func (c *Client) MkdirAll(path string, _ os.FileMode) (err error)
```

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

### Sys method

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/file.md

Always returns nil for os.FileInfo interface compatibility.

```go
func (f File) Sys() interface{} {
	return nil
}
```

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

### String method signature

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/basicAuth.md

Returns fmt.Sprintf("BasicAuth login: %s", b.user).

```go
func (b *BasicAuth) String() string
```

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

### Get file/folder info (STAT)

Source: https://github.com/studio-b12/gowebdav/blob/master/cmd/gowebdav/README.md

Retrieve information about a folder or a file on the remote WebDAV server.

```sh
gowebdav -X STAT temp
gowebdav -X STAT temp/file.txt

```

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

### String method

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/file.md

Returns a human-readable dump: for directories 'Dir : '<path>' - '<name>'', for files 'File: '<path>' SIZE: <n> MODIFIED: <t> ETAG: <e> CTYPE: <contentType>'.

```go
func (f File) String() string
```

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

### Mode method

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/file.md

Returns 0775 | os.ModeDir for directories, 0664 for files. Real permissions are not fetched from the server.

```go
func (f File) Mode() os.FileMode
```

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

### PassportAuth Clone method

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/passportAuth.md

Copies the cookie slice so per-request instances can update cookies independently. The clone starts with inhibitRedirect set to true.

```go
func (p *PassportAuth) Clone() Authenticator
```

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

### BasicAuth.String

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/basicAuth.md

Returns fmt.Sprintf("BasicAuth login: %s", b.user).

```APIDOC
## BasicAuth.String

### Description
Returns fmt.Sprintf("BasicAuth login: %s", b.user).

### Method
String

### Signature
func (b *BasicAuth) String() string

### Parameters
None.

### Return Value
- **string** - The string representation.
```

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

### Client.Mkdir

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Creates a directory on the WebDAV server.

```APIDOC
## [METHOD] Client.Mkdir(path string, _ os.FileMode) (err error)

### Description
Creates a directory on the WebDAV server.

### Signature
`func (c *Client) Mkdir(path string, _ os.FileMode) (err error)`

### Parameters
- **path** (string) - Required - The directory path.
- **_ os.FileMode** - Required - The file mode (ignored).

### Returns
- **error** - An error if the directory creation fails.
```

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

### File type

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

File is the structure for a given file.

```go
type File struct {
    // contains filtered or unexported fields
}

```

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

### SetTimeout: Set per-request timeout

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

SetTimeout sets the timeout on the underlying http.Client. A zero value disables the timeout. The example sets a 30-second per-request time limit.

```go
func (c *Client) SetTimeout(timeout time.Duration)
```

```go
c.SetTimeout(30 * time.Second)
```

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

### Create remote folders (MKDIR and MKDIRALL)

Source: https://github.com/studio-b12/gowebdav/blob/master/cmd/gowebdav/README.md

Create a single folder or a directory hierarchy on the remote server.

```sh
gowebdav -X MKDIR temp2
gowebdav -X MKDIRALL all/folders/which-you-want/to_create

```

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

### NewClient

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/types.md

Creates a new WebDAV client with basic authentication.

```APIDOC
## NewClient

### Description
Creates a new WebDAV client with basic authentication.

### Signature
```go
func NewClient(uri, user, pw string) *Client
```

### Parameters
- **uri** (string) - The base URI of the WebDAV server.
- **user** (string) - The username for basic auth.
- **pw** (string) - The password for basic auth.

### Returns
- **\*Client** - The created client.

### Source
`client.go:28`
```

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

### ReadStream method signature

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

Signature for the ReadStream method. Opens a streaming download (GET, no range header). On 200 the raw response body is returned; the caller must close it.

```go
func (c *Client) ReadStream(path string) (io.ReadCloser, error)
```

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

### Join function

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Join joins two paths.

```go
func Join(path0 string, path1 string) string
```

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

### Path method

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/file.md

Returns the full WebDAV path, including the client's base root concatenation. Directories receive a trailing slash.

```go
func (f File) Path() string
```

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

### NewClient

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

Convenience constructor for creating a WebDAV client with auto-negotiated authentication.

```APIDOC
## NewClient

### Description
Creates a new WebDAV client with auto-negotiated authentication (Basic, Digest, or Passport).

### Signature
```go
func NewClient(uri, user, pw string) *Client
```

### Parameters
- **uri** (string) - Required - Root WebDAV URL (a trailing `/` is appended via `FixSlash`)
- **user** (string) - Required - Login for the auto-negotiated `BasicAuth` / `DigestAuth` / `PassportAuth`
- **pw** (string) - Required - Password / secret

### Returns
- **\*Client** - Never fails

### Example
```go
c := gowebdav.NewClient("https://webdav.example.com", "user", "secret")
```
```

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

### Client.MkdirAll

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Creates all directories in a path on the WebDAV server.

```APIDOC
## [METHOD] Client.MkdirAll(path string, _ os.FileMode) (err error)

### Description
Creates all directories in a path on the WebDAV server.

### Signature
`func (c *Client) MkdirAll(path string, _ os.FileMode) (err error)`

### Parameters
- **path** (string) - Required - The directory path.
- **_ os.FileMode** - Required - The file mode (ignored).

### Returns
- **error** - An error if the directory creation fails.
```

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

### Stat method

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Returns file statistics for a specified path.

```go
func (c *Client) Stat(path string) (os.FileInfo, error)
```

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

### Explicit options with -netrc-file for gowebdav COPY

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/cli.md

Explicitly sets all options including a custom netrc file path and performs a COPY operation. Demonstrates the -netrc-file flag.

```sh
gowebdav -root https://webdav.example.com -user alice -pw s3cret \
         -netrc-file /etc/webdav.netrc -X COPY docs/a.txt docs/b.txt
```

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

### Client.Connect

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Connects to the WebDAV server.

```APIDOC
## [METHOD] Client.Connect() error

### Description
Connects to the WebDAV server.

### Signature
`func (c *Client) Connect() error`

### Returns
- **error** - An error if connection fails.
```

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

### Remove/RemoveAll: Delete file or collection

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

Remove is an alias for RemoveAll, which deletes a file or collection via DELETE. Returns nil on 200, 204, or 404; otherwise a *os.PathError. The example shows removing a file and handling errors.

```go
func (c *Client) Remove(path string) error
func (c *Client) RemoveAll(path string) error
```

```go
if err := c.Remove("docs/old.txt"); err != nil {
    log.Fatal(err)
}
```

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

### SetTransport: Set custom RoundTripper

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

SetTransport sets a custom transport on the underlying http.Client, useful for TLS configuration or proxy handling. The example configures a transport that uses the environment proxy and skips TLS certificate verification.

```go
func (c *Client) SetTransport(transport http.RoundTripper)
```

```go
c.SetTransport(&http.Transport{
    Proxy: http.ProxyFromEnvironment,
    TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
})
```

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

### SetHeader method

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Sets arbitrary HTTP headers for the client.

```go
func (c *Client) SetHeader(key, value string)
```

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

### SetHeader: Add HTTP header to all requests

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

SetHeader adds an arbitrary HTTP header to every request the client sends. The header is added via Header.Add, so duplicates are allowed. The example shows setting a custom User-Agent header.

```go
func (c *Client) SetHeader(key, value string)
```

```go
c.SetHeader("User-Agent", "my-app/1.0")
```

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

### Connect

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

Verifies server reachability by sending an OPTIONS request.

```APIDOC
## Connect

### Description
Sends an `OPTIONS /` request with a `Depth: 0` header to verify server reachability. The response body is closed; any `2xx` status is treated as success.

### Method
OPTIONS

### Endpoint
/

### Parameters
#### Headers
- **Depth** (string) - Required - Set to `0`.

### Request Example
No request body.

### Response
#### Success Response (2xx)
- **Status** (int) - Any 2xx status code.

#### Error Response
- **Status** (int) - Non-2xx status code.

### Error Handling
- Returns `nil` on success.
- Returns `*os.PathError` with op `"Connect"` for non-2xx status.
- Returns raw error for transport failures.
```

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

### Automatic negotiation with NewAutoAuth

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/passportAuth.md

Registers Passport after basic and digest in NewAutoAuth. When the server challenges with a Passport1.4 header that neither Basic nor Digest matches, Passport is chosen. The example connects and reads a file, logging a fatal error if no authenticator matches.

```go
c := gowebdav.NewClient("https://webdav.example.com", "me@example.com", "pw")
if err := c.Connect(); err != nil {
    log.Fatal(err) // no matching authenticator -> NewPathError("NoAuthenticator", ...)
}
data, err := c.Read("Shared Documents/report.xlsx")
```

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

### Mkdir

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

Creates a single remote collection.

```APIDOC
## Mkdir

### Description
Creates a single remote collection via `MKCOL`. A `405` response is silently promoted to success.

### Method
MKCOL

### Endpoint
{path}

### Parameters
#### Path Parameters
- **path** (string) - Required - Collection path.

### Request Example
No request body.

### Response
#### Success Response (201)
- **Status** (int) - 201 Created.

#### Error Response
- **other** (int) - Any other status code.

### Error Handling
- Returns `nil` on `201`.
- Returns `NewPathError("Mkdir", path, status)` otherwise.
- Returns raw error if the `MKCOL` request failed.
```

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

### Size method

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/file.md

Returns the content length in bytes from DAV: getcontentlength. Returns 0 for directories and for unparseable values.

```go
func (f File) Size() int64
```

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

### SetInterceptor: Register request callback

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

SetInterceptor registers a callback invoked for every request after the Authenticator and per-call intercept function, but before the request is sent. The callback receives the HTTP method and the fully prepared *http.Request. The example logs the method and URL for each request.

```go
func (c *Client) SetInterceptor(interceptor func(method string, rq *http.Request))
```

```go
c.SetInterceptor(func(method string, rq *http.Request) {
    log.Printf("%s %s", method, rq.URL)
})
```

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

### gowebdav CLI Usage

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/cli.md

The gowebdav command-line tool provides a set of WebDAV operations via the -X flag. It accepts one or two positional arguments depending on the operation.

```APIDOC
## gowebdav CLI

### Description
The gowebdav CLI is a command-line interface for performing WebDAV operations. It wraps the gowebdav Client library and supports operations such as listing directories, reading files, uploading files, creating directories, renaming, copying, and deleting.

### Usage
```
gowebdav [flags] <arg1> [arg2]
```

### Flags
| Flag | Env Var | Default | Description |
|------|---------|---------|-------------|
| `-root` | `ROOT` | `""` | WebDAV endpoint URL. Required. |
| `-user` | `USER` | `""` | Username. |
| `-pw` | `PASSWORD` | `""` | Password. If empty, netrc file is consulted. |
| `-netrc-file` | — | `<home>/.netrc` | Path to netrc file. |
| `-X` | — | `""` | WebDAV method to execute. |

### Methods (-X)

#### LS, LIST, PROPFIND
Lists directory contents.
- **Arguments**: `p0` (path)
- **Behavior**: Calls `ReadDir(p0)` and prints entries.

#### STAT
Gets file status.
- **Arguments**: `p0` (path)
- **Behavior**: Calls `Stat(p0)` and prints file info.

#### GET, PULL, READ
Downloads a file.
- **Arguments**: `p0` (remote path), `p1` (local path, optional, default `./<p0>`)
- **Behavior**: Calls `Read(p0)` and writes bytes to local file with mode 0644.

#### DELETE, RM, DEL
Deletes a file or directory.
- **Arguments**: `p0` (path)
- **Behavior**: Calls `Remove(p0)`.

#### MKCOL, MKDIR
Creates a directory.
- **Arguments**: `p0` (path)
- **Behavior**: Calls `Mkdir(p0, 0755)`.

#### MKCOLALL, MKDIRALL, MKDIRP
Creates a directory and all parent directories.
- **Arguments**: `p0` (path)
- **Behavior**: Calls `MkdirAll(p0, 0755)`.

#### RENAME, MV, MOVE
Renames or moves a file/directory.
- **Arguments**: `p0` (source), `p1` (destination)
- **Behavior**: Calls `Rename(p0, p1, true)` (overwrite always on).

#### COPY, CP
Copies a file/directory.
- **Arguments**: `p0` (source), `p1` (destination)
- **Behavior**: Calls `Copy(p0, p1, true)`.

#### PUT, PUSH, WRITE
Uploads a local file to the server.
- **Arguments**: `p0` (local path), `p1` (remote path, optional, default `./<p0>`)
- **Behavior**: If `p1` is given and `p0` is an existing directory, the target becomes `path.Join(p0, p1)`. Uses `WriteStream(p0, stream, 0644)`.

### Examples
```sh
# Environment-configured endpoint
export ROOT=https://webdav.example.com USER=alice PASSWORD=s3cret
gowebdav -X LS docs
gowebdav -X GET docs/file.txt /tmp/file.txt
gowebdav -X PUT uploads/file.txt docs/file.txt
gowebdav -X MKDIRALL a/b/c
gowebdav -X MV docs/a.txt docs/b.txt
gowebdav -X DEL docs/b.txt
```

```sh
# netrc-based credentials
gowebdav -root https://webdav.example.com -X STAT docs
# requires ~/.netrc: machine webdav.example.com login alice password s3cret
```

```sh
# Explicit options
gowebdav -root https://webdav.example.com -user alice -pw s3cret \
         -netrc-file /etc/webdav.netrc -X COPY docs/a.txt docs/b.txt
```

### Error Handling
- Any command error prints the error and exits with code -1.
- Unknown `-X` method prints `Unsupported method: <method>`.
- `Connect()` failure panics.

```

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

### NewClient constructor signature

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

Convenience constructor equivalent to NewAuthClient(uri, NewAutoAuth(user, pw)). Appends a trailing slash to the URI via FixSlash. Never fails. Declared at client.go:28.

```go
func NewClient(uri, user, pw string) *Client
```

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

### Read

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/client.md

Downloads a file fully into memory as a byte slice.

```APIDOC
## Read

### Description
Downloads a file fully into memory. Delegates to ReadStream internally and drains the stream into a bytes.Buffer.

### Method
GET (via ReadStream)

### Endpoint
Not explicitly specified; uses the client's base URL and path.

### Parameters
#### Path Parameters
- **path** (string) - Required - Remote file path

### Request Example
```go
data, err := c.Read("docs/file.txt")
if err != nil {
    log.Fatal(err)
}
os.WriteFile("/tmp/file.txt", data, 0644)
```

### Response
#### Success Response
Returns the file content as `[]byte`.

#### Error Response
Returns `nil` plus the error from ReadStream or from draining the body.
```

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

### File.Sys

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/file.md

Always returns nil for os.FileInfo interface compatibility.

```APIDOC
## Sys

### Description
Always returns nil for os.FileInfo interface compatibility.

### Method
Sys

### Endpoint
N/A (method on File)

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **sys** (interface{}) - Always nil.

#### Response Example
null
```

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

### File.String

Source: https://github.com/studio-b12/gowebdav/blob/master/_autodocs/api-reference/file.md

Returns a human-readable dump of the file or directory information.

```APIDOC
## String

### Description
Returns a human-readable dump of the file or directory information.

### Method
String

### Endpoint
N/A (method on File)

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **string** (string) - Human-readable representation.

#### Response Example
"File: 'docs/file.txt' SIZE: 1024 MODIFIED: 2023-01-01 00:00:00 +0000 UTC ETAG: \"abc\" CTYPE: text/plain"
```

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

### File.Sys

Source: https://github.com/studio-b12/gowebdav/blob/master/README.md

Returns system-specific information about the file.

```APIDOC
## func (f File) Sys() interface{}

### Description
Sys returns system-specific information about the file.

### Returns
- **interface{}** - System-specific information.
```
Tokens:
Raw