Files
bitburner-src/markdown/bitburner.ns.scp.md

2.4 KiB
Raw Blame History

Home > bitburner > NS > scp

NS.scp() method

Copy file between servers.

Signature:

scp(files: string | string[], destination: string, source?: string): boolean;

Parameters

Parameter

Type

Description

files

string | string[]

Filename or an array of filenames of script/literature files to copy. Note that if a file is located in a subdirectory, the filename must include the leading /.

destination

string

Hostname/IP of the destination server, which is the server to which the file will be copied.

source

string

(Optional) Hostname/IP of the source server, which is the server from which the file will be copied. This argument is optional and if its omitted the source will be the current server.

Returns:

boolean

True if the file is successfully copied over and false otherwise. If the files argument is an array then this function will return false if any of the operations failed.

Remarks

RAM cost: 0.6 GB

Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string specifying a single file to copy, or an array of strings specifying multiple files to copy.

Example 1

//Copies foo.lit from the helios server to the home computer:
ns.scp("foo.lit", "home", "helios" );

//Tries to copy three files from rothman-uni to home computer:
const files = ["foo1.lit", "foo2.txt", "foo3.js"];
ns.scp(files, "home", "rothman-uni");

Example 2

const server = ns.args[0];
const files = ["hack.js", "weaken.js", "grow.js"];
ns.scp(files, server, "home");

For darknet servers: The destination requires a session, but unlike exec, does not require a direct connection — scp works at any distance. The source server has no darknet requirements (no session or connection needed). Use dnet.authenticate (requires direct connection) or dnet.connectToSession (at any distance) to establish a session.