Skip to content

SFTP (Source)

Downloads files from an SFTP server.

Configuration

yaml
source:
  kind: sftp
  host: sftp.example.com
  username: user
  password: ${SFTP_PASSWORD}
  remote_path: "/data/*.json"
FieldDefaultDescription
host(required)SFTP server hostname
port22SSH port
username(required)SSH username
passwordPassword authentication
private_key_pathPath to SSH private key
remote_path(required)Remote file path or glob

Namespace: sftp.{filename}

CLI

bash
skippr connect source sftp \
  --host sftp.example.com \
  --username myuser \
  --private-key-path ~/.ssh/id_rsa \
  --remote-path /data/exports/
FlagDescription
--hostSFTP server hostname
--portSSH port (default: 22)
--usernameSSH username
--passwordPassword (or use --private-key-path)
--private-key-pathPath to SSH private key
--remote-pathRemote file path or glob pattern