Linux "sftp" Command Line Options and Examples
secure file transfer program

sftp is an interactive file transfer program, similar to ftp(1), which performs all operations over an encrypted ssh(1) transport. It may also use many features of ssh, such as public key authentication and compression. sftp connects and logs into the specified host, then enters an interactive command mode.


Usage:

sftp [-46aCfpqrv] [-B buffer_size] [-b batchfile] [-c cipher] [-D sftp_server_path] [-F ssh_config]
[-i identity_file] [-l limit] [-o ssh_option] [-P port] [-R num_requests] [-S program]
[-s subsystem | sftp_server] host
sftp [user@]host[:file ...]
sftp [user@]host[:dir[/]]
sftp -b batchfile [user@]host






Command Line Options:

-4
Forces sftp to use IPv4 addresses only.
sftp -4 ...
-6
Forces sftp to use IPv6 addresses only.
sftp -6 ...
-B
Specify the size of the buffer that sftp uses when transferring files. Larger buffers require fewerround trips at the cost of higher memory consumption. The default is 32768 bytes.
sftp -B ...
-b
Batch mode reads a series of commands from an input batchfile instead of stdin. Since it lacks userinteraction it should be used in conjunction with non-interactive authentication. A batchfile of ‘-’may be used to indicate standard input. sftp will abort if any of the following commands fail: get,put, reget, reput, rename, ln, rm, mkdir, chdir, ls, lchdir, chmod, chown, chgrp, lpwd, df, symlink, andlmkdir. Termination on error can be suppressed on a command by command basis by prefixing the commandwith a ‘-’ character (for example, -rm /tmp/blah*).
sftp -b ...
-C
Enables compression (via ssh's -C flag).
sftp -C ...
-c
Selects the cipher to use for encrypting the data transfers. This option is directly passed to ssh(1).
sftp -c ...
-D
Connect directly to a local sftp server (rather than via ssh(1)). This option may be useful in debug‐ging the client and server.
sftp -D ...
-F
Specifies an alternative per-user configuration file for ssh(1). This option is directly passed tossh(1).
sftp -F ...
-i
Selects the file from which the identity (private key) for public key authentication is read. Thisoption is directly passed to ssh(1).
sftp -i ...
-l
Limits the used bandwidth, specified in Kbit/s.
sftp -l ...
-o
Can be used to pass options to ssh in the format used in ssh_config(5). This is useful for specifyingoptions for which there is no separate sftp command-line flag. For example, to specify an alternateport use: sftp -oPort=24. For full details of the options listed below, and their possible values, seessh_config(5).AddressFamilyBatchModeBindAddressCanonicalDomainsCanonicalizeFallbackLocalCanonicalizeHostnameCanonicalizeMaxDotsCanonicalizePermittedCNAMEsCertificateFileChallengeResponseAuthenticationCheckHostIPCiphersCompressionConnectionAttemptsConnectTimeoutControlMasterControlPathControlPersistGlobalKnownHostsFileGSSAPIAuthenticationGSSAPIDelegateCredentialsHashKnownHostsHostHostbasedAuthenticationHostbasedKeyTypesHostKeyAlgorithmsHostKeyAliasHostNameIdentitiesOnlyIdentityAgentIdentityFileIPQoSKbdInteractiveAuthenticationKbdInteractiveDevicesKexAlgorithmsLogLevelMACsNoHostAuthenticationForLocalhostNumberOfPasswordPromptsPasswordAuthenticationPKCS11ProviderPortPreferredAuthenticationsProxyCommandProxyJumpPubkeyAcceptedKeyTypesPubkeyAuthenticationRekeyLimitSendEnvServerAliveIntervalServerAliveCountMaxStrictHostKeyCheckingTCPKeepAliveUpdateHostKeysUsePrivilegedPortUserUserKnownHostsFileVerifyHostKeyDNS
sftp -o ...
-P
Specifies the port to connect to on the remote host.
sftp -P ...
-p
Preserves modification times, access times, and modes from the original files transferred.
sftp -p ...
-q
Quiet mode: disables the progress meter as well as warning and diagnostic messages from ssh(1).
sftp -q ...
-R
Specify how many requests may be outstanding at any one time. Increasing this may slightly improve filetransfer speed but will increase memory usage. The default is 64 outstanding requests.
sftp -R ...
-S
Name of the program to use for the encrypted connection. The program must understand ssh(1) options.
sftp -S ...
-s
Specifies the SSH2 subsystem or the path for an sftp server on the remote host. A path is useful whenthe remote sshd(8) does not have an sftp subsystem configured.
sftp -s ...
-v
INTERACTIVE COMMANDSOnce in interactive mode, sftp understands a set of commands similar to those of ftp(1). Commands are caseinsensitive. Pathnames that contain spaces must be enclosed in quotes. Any special characters contained withinpathnames that are recognized by glob(3) must be escaped with backslashes (‘\’).bye Quit sftp.cd pathChange remote directory to path.chgrp grp pathChange group of file path to grp. path may contain glob(3) characters and may match multiple files.grp must be a numeric GID.chmod mode pathChange permissions of file path to mode. path may contain glob(3) characters and may match multiplefiles.chown own pathChange owner of file path to own. path may contain glob(3) characters and may match multiple files.own must be a numeric UID.df [-hi] [path]Display usage information for the filesystem holding the current directory (or path if specified). Ifthe -h flag is specified, the capacity information will be displayed using "human-readable" suffixes.The -i flag requests display of inode information in addition to capacity information. This command isonly supported on servers that implement the “statvfs@openssh.com” extension.exit Quit sftp.get [-afPpr] remote-path [local-path]Retrieve the remote-path and store it on the local machine. If the local path name is not specified, itis given the same name it has on the remote machine. remote-path may contain glob(3) characters and maymatch multiple files. If it does and local-path is specified, then local-path must specify a directory.If the -a flag is specified, then attempt to resume partial transfers of existing files. Note thatresumption assumes that any partial copy of the local file matches the remote copy. If the remote filecontents differ from the partial local copy then the resultant file is likely to be corrupt.If the -f flag is specified, then fsync(2) will be called after the file transfer has completed to flushthe file to disk.If either the -P or -p flag is specified, then full file permissions and access times are copied too.If the -r flag is specified then directories will be copied recursively. Note that sftp does not followsymbolic links when performing recursive transfers.help Display help text.lcd pathChange local directory to path.lls [ls-options [path]]Display local directory listing of either path or current directory if path is not specified.ls-options may contain any flags supported by the local system's ls(1) command. path may containglob(3) characters and may match multiple files.lmkdir pathCreate local directory specified by path.ln [-s] oldpath newpathCreate a link from oldpath to newpath. If the -s flag is specified the created link is a symbolic link,otherwise it is a hard link.lpwd Print local working directory.ls [-1afhlnrSt] [path]Display a remote directory listing of either path or the current directory if path is not specified.path may contain glob(3) characters and may match multiple files.The following flags are recognized and alter the behaviour of ls accordingly:
sftp -v ...
-1
Produce single columnar output.
sftp -1 ...
-a
List files beginning with a dot (‘.’).
sftp -a ...
-f
Do not sort the listing. The default sort order is lexicographical.
sftp -f ...
-n
Produce a long listing with user and group information presented numerically.
sftp -n ...
-r
Reverse the sort order of the listing.
sftp -r ...
-t
lumask umaskSet local umask to umask.mkdir pathCreate remote directory specified by path.progressToggle display of progress meter.put [-afPpr] local-path [remote-path]Upload local-path and store it on the remote machine. If the remote path name is not specified, it isgiven the same name it has on the local machine. local-path may contain glob(3) characters and maymatch multiple files. If it does and remote-path is specified, then remote-path must specify a direc‐tory.If the -a flag is specified, then attempt to resume partial transfers of existing files. Note thatresumption assumes that any partial copy of the remote file matches the local copy. If the local filecontents differ from the remote local copy then the resultant file is likely to be corrupt.If the -f flag is specified, then a request will be sent to the server to call fsync(2) after the filehas been transferred. Note that this is only supported by servers that implement the"fsync@openssh.com" extension.If either the -P or -p flag is specified, then full file permissions and access times are copied too.If the -r flag is specified then directories will be copied recursively. Note that sftp does not followsymbolic links when performing recursive transfers.pwd Display remote working directory.quit Quit sftp.reget [-Ppr] remote-path [local-path]Resume download of remote-path. Equivalent to get with the -a flag set.reput [-Ppr] [local-path] remote-pathResume upload of [local-path]. Equivalent to put with the -a flag set.rename oldpath newpathRename remote file from oldpath to newpath.rm pathDelete remote file specified by path.rmdir pathRemove remote directory specified by path.symlink oldpath newpathCreate a symbolic link from oldpath to newpath.versionDisplay the sftp protocol version.!commandExecute command in local shell.! Escape to local shell.? Synonym for help.
sftp -t ...