Skip to main content
Home

Built and signed on GitHub Actions

An sftp client class, wrapping the `sftp` cli

This package works with DenoIt is unknown whether this package works with Cloudflare Workers, Node.js
It is unknown whether this package works with Cloudflare Workers
It is unknown whether this package works with Node.js
This package works with Deno
JSR Score
100%
Published
a year ago (0.5.1)

This module provides a simple adapter to the SFTP client cli. It's not a complete wrapper right now, but it provides the basic functionality to interact with the SFTP client.

Important

This module does not handle any SSH config right now. You need to have the host you want to use in your SSH config setup on your machine. Example: my-host should be a valid host in your SSH config, complete with authorization information (in the example: 'maya-dev').

Examples

Example 1

import { SftpClient } from "@codemonument/sftp-client";

const sftpClient = new SftpClient({
   cwd: "playground",
   host: "maya-dev",
   uploaderName: "sftp_1",
});

await sftpClient.ls();

await sftpClient.close();
Built and signed on
GitHub Actions

New Ticket: Report package

Please provide a reason for reporting this package. We will review your report and take appropriate action.

Please review the JSR usage policy before submitting a report.

Add Package

deno add jsr:@codemonument/sftp-client

Import symbol

import * as sftp_client from "@codemonument/sftp-client";
or

Import directly with a jsr specifier

import * as sftp_client from "jsr:@codemonument/sftp-client";

Add Package

pnpm i jsr:@codemonument/sftp-client
or (using pnpm 10.8 or older)
pnpm dlx jsr add @codemonument/sftp-client

Import symbol

import * as sftp_client from "@codemonument/sftp-client";

Add Package

yarn add jsr:@codemonument/sftp-client
or (using Yarn 4.8 or older)
yarn dlx jsr add @codemonument/sftp-client

Import symbol

import * as sftp_client from "@codemonument/sftp-client";

Add Package

vlt install jsr:@codemonument/sftp-client

Import symbol

import * as sftp_client from "@codemonument/sftp-client";

Add Package

npx jsr add @codemonument/sftp-client

Import symbol

import * as sftp_client from "@codemonument/sftp-client";