Install directly from PyPI, using pip
pip install fs.sshfs
fs.open_fs to open a filesystem with an SSH
import fs my_fs = fs.open_fs("ssh://[user[:password]@]host[:port]/[directory]")
sftp scheme can be used as an alias for the
ssh scheme in
the FS URL. The following URL parameters are supported:
For a more granular way of connecting to an SSH server, use the
fs.sshfs.SSHFS constructor, which signature is:
from fs.sshfs import SSHFS my_fs = SSHFS( host, user=None, passwd=None, pkey=None, timeout=10, port=22, keepalive=10, compress=False, config_path='~/.ssh/config' )
with each argument explained below:
- the name or IP address of the SSH server
- the username to connect with, defaults to the current user.
- an optional password, used to connect directly to the server or to decrypt the public key, if any given.
- a paramiko.PKey object, a path, or a list of paths to an SSH key.
- the timeout, in seconds, for networking operations.
- the port the SSH server is listening on.
- the interval of time between keepalive packets, in seconds. Set to 0 to disable.
- set to
Trueto compress the communications with the server
- the path to an OpenSSH configuration file.
Additional keyword arguments will be passed to the underlying connection call,
taking precedence over implicitly derived arguments. Once created, the
SSHFS filesystem behaves like any other filesystem (see the Pyfilesystem2
SSHFS.openbin has the following extra options that can be passed as keyword arguments to control the file buffering:
- enabled by default, use a background thread to prefetch the content of a file opened in reading mode. Does nothing for files in writing mode.
- enable pipelined mode, avoid waiting for server answer between two uploaded chunks. Does nothing for files in reading mode.
SSHFS are aware of SSH config files
and as such, one of the hosts in the configuration file can be provided as the
host argument for the filesystem to connect to the server with the proper
Found a bug ? Have an enhancement request ? Head over to the GitHub issue tracker of the project if you need to report or ask something. If you are filling in on a bug, please include as much information as you can about the issue, and try to recreate the same bug in a simple, easily reproductible situation.