github.com/pkg/sftp@v1.13.6/README.md (about)

     1  sftp
     2  ----
     3  
     4  The `sftp` package provides support for file system operations on remote ssh
     5  servers using the SFTP subsystem. It also implements an SFTP server for serving
     6  files from the filesystem.
     7  
     8  ![CI Status](https://github.com/pkg/sftp/workflows/CI/badge.svg?branch=master&event=push) [![Go Reference](https://pkg.go.dev/badge/github.com/pkg/sftp.svg)](https://pkg.go.dev/github.com/pkg/sftp)
     9  
    10  usage and examples
    11  ------------------
    12  
    13  See [https://pkg.go.dev/github.com/pkg/sftp](https://pkg.go.dev/github.com/pkg/sftp) for
    14  examples and usage.
    15  
    16  The basic operation of the package mirrors the facilities of the
    17  [os](http://golang.org/pkg/os) package.
    18  
    19  The Walker interface for directory traversal is heavily inspired by Keith
    20  Rarick's [fs](https://pkg.go.dev/github.com/kr/fs) package.
    21  
    22  roadmap
    23  -------
    24  
    25  * There is way too much duplication in the Client methods. If there was an
    26    unmarshal(interface{}) method this would reduce a heap of the duplication.
    27  
    28  contributing
    29  ------------
    30  
    31  We welcome pull requests, bug fixes and issue reports.
    32  
    33  Before proposing a large change, first please discuss your change by raising an
    34  issue.
    35  
    36  For API/code bugs, please include a small, self contained code example to
    37  reproduce the issue. For pull requests, remember test coverage.
    38  
    39  We try to handle issues and pull requests with a 0 open philosophy. That means
    40  we will try to address the submission as soon as possible and will work toward
    41  a resolution. If progress can no longer be made (eg. unreproducible bug) or
    42  stops (eg. unresponsive submitter), we will close the bug.
    43  
    44  Thanks.