SFTP (Source)

Install

See the Install guide for the full setup, including Windows PowerShell.

curl -fsSL https://install.skippr.io/install.sh | shClick to copy

Downloads files from an SFTP server.

Configuration

source:
  kind: sftp
  host: sftp.example.com
  username: user
  password: ${SFTP_PASSWORD}
  remote_path: "/data/*.json"

Field	Default	Description
host	(required)	SFTP server hostname
port	22	SSH port
username	(required)	SSH username
password		Password authentication
private_key_path		Path to SSH private key
remote_path	(required)	Remote file path or glob

Namespace: sftp.{filename}

CLI

skippr connect source sftp \
  --host sftp.example.com \
  --username myuser \
  --private-key-path ~/.ssh/id_rsa \
  --remote-path /data/exports/

Flag	Description
--host	SFTP server hostname
--port	SSH port (default: 22)
--username	SSH username
--password	Password (or use --private-key-path)
--private-key-path	Path to SSH private key
--remote-path	Remote file path or glob pattern

Authentication

Use either a password or an SSH private key. Prefer private-key auth for long-lived pipelines. For security best practices, we strongly advise against storing the password in skippr.yaml. Use environment variable interpolation instead: replace the password value with your own ${ENV_VAR} reference.

The relevant part of skippr.yaml looks like this:

source:
  kind: sftp
  password: ${SFTP_PASSWORD}

Set the env var before running skippr:

macOS / Linux

export SFTP_PASSWORD="secret"

Windows PowerShell

$env:SFTP_PASSWORD = "secret"

Windows Command Prompt

set SFTP_PASSWORD=secret

Permissions or Network Requirements

The SSH user needs read access to the selected remote path, and the machine running skippr must be able to reach the SFTP host on the configured port.

Troubleshooting

Symptom	Fix
authentication failed	Verify the username, password or private key path, and any host-based access controls.
no files found	Check remote_path and confirm the SSH user can list and read that location.

Next steps

• Pair this source with a destination from Destination Connectors.
• See How It Works for the end-to-end pipeline flow.

Install

See the Install guide for the full setup, including Windows PowerShell.

curl -fsSL https://install.skippr.io/install.sh | shClick to copy