Copy files

Northflank allows you to download resources from your running workloads (services or jobs) and upload resources from your local machine to workloads.

File and directory copy is available via the Northflank CLI or JavaScript client and enables you to copy single files or entire directories.

You can easily transfer files and directories using the Northflank CLI.

• To upload a single file to a running service:

northflank upload service file --projectId [project-name] --service [service-name] --localPath test.txt --remotePath test-file.txt

• To upload a directory to a running service:

northflank upload service file --projectId [project-name] --service [service-name] --localPath my-directory/ --remotePath /home/my-directory

• To download a directory from a running service:

northflank download service file --projectId [project-name] --service [service-name] --localPath my-directory --remotePath /home/my-directory

For jobs, the analog commands can be used: northflank [download|upload] job file <args>

Some arguments are optional in specific scenarios:

• For downloads, the --localPath argument can be omitted. In this case the current working directory from which the CLI is started is used to stored the downloaded files.
• For uploads, the --remotePath argument can be omitted. In this case the default home directory of the container user is used to stored the downloaded files.

Refer to the command help for a full view of all allowed CLI arguments:

northflank upload service file --help

The JavaScript client provides functionality which allows copying file and directories programmatically. To copy files, the JS client exposes upload and download modules which expect a localPath and a remotePath:

const res = await apiClient.upload.service.files({ projectId, serviceId }, { localPath, remotePath, });

const res = await apiClient.download.service.files({ projectId, serviceId }, { localPath, remotePath, });

Both commands can be used for services and jobs.