nortre-cli

Deprecation warning

This pip package will be depricated at the end of 2026. Please transfer over to the new package located at https://pypi.org/project/nortre-cli/

Description

A python package for interacting with SAFE File transfer API

Current Functionalities

• Generate a JWT Token
• Import file/s
• Export a file
• Exit

Prerequisite

• Having minimum Python 3.12 installed in your system and setting up a Python Virtual Environment.

Workflow

• Activate your Python Virtual Environment,
• Then run the following command.

pip install nortre-cli

• To see all the available commands and options run the following

safe-cli

Usage:

$ safe-cli [OPTIONS] COMMAND [ARGS]...

Options:

• --help, --man, --manual: Show help and exit.

Commands:

• get-token: Get and store access token
• import-file: Import file/s
• export-file: Export a file
• interactive: Run interactive mode
• exit: Exits the cli

safe-cli get-token

Get and store access token

Usage:

$ safe-cli get-token [OPTIONS]

Options:

• --help, --man, --manual: Show help and exit.

safe-cli import-file

Import a file

Usage:

$ safe-cli import-file [OPTIONS]

Options:

• --server TEXT: Server name
• --filename FILE: Path to file to be imported
• -i, --interactive: Run import interactively
• --help, --man, --manual: Show help and exit.

safe-cli export-file

Export a file

Usage:

$ safe-cli export-file [OPTIONS]

Options:

• --server TEXT: Server name
• --filename TEXT: Filename to export
• --output-dir DIRECTORY: Output directory
• -i, --interactive: Run export interactively
• --help, --man, --manual: Show help and exit.

safe-cli interactive

Run interactive mode

Usage:

$ safe-cli interactive [OPTIONS]

Options:

• --help, --man, --manual: Show help and exit.