Skip to main content
A directory on a remote server becomes a local-looking tree of files, read and written over SFTP. It works from Python and Node.

Setup

The server needs SFTP turned on and an SSH account with access to the directory. Create a key and install it on the server, then check that SFTP answers:
  • private_key takes the key’s own text in place of identity_file’s path, so a credential pointer can read it from a secret store.
  • Without identity_file or private_key, the SSH agent and the default keys in ~/.ssh are tried. password works too, but a key is preferred.

Connect

workspace.yaml

Layout

  • /remote/logs/app.log is /srv/data/logs/app.log on the server.
  • In Python, host also matches a ~/.ssh/config alias, and its settings apply.
  • Host keys are checked only in Python with known_hosts set; the TypeScript VFS does not verify them.

Sample runs

mode: write allows changes, as far as the SSH account’s permissions allow. To run programs on the server, use the SSH machine.

SDK guides

Python

Every config field, the VFS.md and write support.

TypeScript

Every config field, the VFS.md and write support.