Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tlux/sftp_client
An Elixir SFTP Client that wraps Erlang's ssh and ssh_sftp.
https://github.com/tlux/sftp_client
elixir elixir-library hex-package sftp sftp-client ssh
Last synced: 5 days ago
JSON representation
An Elixir SFTP Client that wraps Erlang's ssh and ssh_sftp.
- Host: GitHub
- URL: https://github.com/tlux/sftp_client
- Owner: tlux
- License: mit
- Created: 2019-05-09T15:50:29.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-03-25T21:16:28.000Z (8 months ago)
- Last Synced: 2024-03-25T22:29:43.622Z (8 months ago)
- Topics: elixir, elixir-library, hex-package, sftp, sftp-client, ssh
- Language: Elixir
- Size: 268 KB
- Stars: 38
- Watchers: 10
- Forks: 21
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# SFTP Client
[](https://github.com/tlux/sftp_client/actions/workflows/elixir.yml)
[](https://coveralls.io/github/tlux/sftp_client?branch=main)
[](https://hex.pm/packages/sftp_client)
[](https://hexdocs.pm/sftp_client/)
[](https://hex.pm/packages/sftp_client)
[](https://github.com/tlux/sftp_client/blob/main/LICENSE.md)
[](https://github.com/tlux/sftp_client/commits/main)
An Elixir SFTP Client that wraps Erlang's
[ssh](http://erlang.org/doc/man/ssh.html) and
[ssh_sftp](http://erlang.org/doc/man/ssh_sftp.html).
## Prerequisites
- Erlang 24 or greater
- Elixir 1.11 or greater
## Installation
The package can be installed by adding `:sftp_client` to your list of
dependencies in `mix.exs`:
```elixir
def deps do
[
{:sftp_client, "~> 2.1"}
]
end
```
## Usage
There are bang (!) counterparts for almost all available functions.
### Connect & Disconnect
To open a new connection to an SFTP server:
```elixir
{:ok, conn} = SFTPClient.connect(host: "ftp.myhost.com")
```
Due to a [change in OTP
24](https://github.com/erlang/otp/commit/59285df73841273adb111996cdb590ae1b86742b)
that removed automatic public key lookup in the sftp module you may need to
define the `modify_algorithms` option to avoid "Key exchange failed" errors:
```elixir
{:ok, conn} = SFTPClient.connect(
host: "ftp.myhost.com",
modify_algorithms: [
append: [
public_key: [:"ssh-rsa"]
]
]
)
```
Refer to the docs for `SFTPClient.Operations.Connect.connect/1` to find out
all available options.
It is strongly recommended to close a connection after your operations have
completed:
```elixir
SFTPClient.disconnect(conn)
```
For short-lived connections you can also use a function as second argument.
After the function body has run or raises, the connection is automatically
closed.
```elixir
SFTPClient.connect([host: "ftp.myhost.com"], fn conn ->
# Do something with conn
end)
```
### Download
To download a file from the server you can use the following function.
```elixir
SFTPClient.download_file(conn, "my/remote/dir/file.jpg", "my/dir/local-file.jpg")
# => {:ok, "my/dir/local-file.jpg"}
```
When the third argument is an existing directory on your file system, the file
is downloaded to a file with the same name as the one on the server.
```elixir
SFTPClient.download_file(conn, "my/remote/dir/image.png", "my/local/dir")
# => {:ok, "my/local/dir/image.png"}
```
It is also possible to use Streams to download data into a file or memory.
```elixir
source_stream = SFTPClient.stream_file!(conn, "my/remote/file.jpg")
target_stream = File.stream!("my/local/file.jpg")
source_stream
|> Stream.into(target_stream)
|> Stream.run()
```
### Upload
To upload are file from the file system you can use the following function.
```elixir
SFTPClient.upload_file(conn, "my/local/dir/file.jpg", "my/remote/dir/file.jpg")
# => {:ok, "my/remote/dir/file.jpg"}
```
You can also use Streams to upload data. Please make sure to set a proper chunk
size or the upload may be very slow.
```elixir
source_stream = File.stream!("my/local/file.jpg", [], 32_768)
target_stream = SFTPClient.stream_file!(conn, "my/remote/file.jpg")
source_stream
|> Stream.into(target_stream)
|> Stream.run()
```
### List Directory
```elixir
SFTPClient.list_dir(conn, "my/dir")
# => {:ok, ["my/dir/file_1.jpg", "my/dir/file_2.jpg", ...]}
```
### Create Directory
```elixir
SFTPClient.make_dir(conn, "my/new/dir")
```
Note that this operation fails unless the parent directory exists.
### Delete
To delete a file:
```elixir
SFTPClient.delete_file(conn, "my/remote/file.jpg")
```
To delete a directory:
```elixir
SFTPClient.delete_dir(conn, "my/remote/dir")
```
Note that a directory cannot be deleted as long as it still contains files.
### Rename
To move/rename a file or directory:
```elixir
SFTPClient.rename(conn, "my/remote/file.jpg", "my/remote/new-file.jpg")
```
### File Info
You can retrieve meta data about a file from the server such as file size,
modification time, file permissions, owner and so on.
```elixir
SFTPClient.file_info(conn, "my/remote/file.jpg")
# => {:ok, %File.Stat{...}}
```
Refer to the [`File.Stat`](https://hexdocs.pm/elixir/File.Stat.html) docs for a
list of available file information.
### Symbolic Links
There are also a couple of functions that handle symlinks.
It is possible to get the target of a symlink.
```elixir
SFTPClient.read_link(conn, "my/remote/link.jpg")
# => {:ok, "my/remote/file.jpg"}
```
You can retrieve meta data about symlinks, similar to `file_info/2`.
```elixir
SFTPClient.link_info(conn, "my/remote/link.jpg")
# => {:ok, %File.Stat{...}}
```
And you are able to create symlinks.
```elixir
SFTPClient.make_link(conn, "my/remote/link.jpg", "my/remote/file.jpg")
```
## License
This library is released under the MIT License. See the [LICENSE.md](./LICENSE.md) file
for further details.