module documentation
Undocumented
| Function | main |
Entry point for the CLI-based file reader. |
Entry point for the CLI-based file reader.
This script allows users to perform the following actions:
- Read a local file using the ``--local`` flag.
- Connect to a remote server via SSH to read a file using the ``--ssh``, ``--host``, ``--user``, and ``--password`` flags.
- Execute a shell command locally using the ``--cmd`` flag.
- Check the installed version of the package with ``--version``.
Example:
To read a local file:
- python -m pyalma.main --local ./data.txt
To read a remote file via SSH:
- python -m pyalma.main --ssh /remote/path.txt --host alma.icr.ac.uk --user myuser --password secret
To run a local command:
- python -m pyalma.main --cmd "ls -l"
:return: None :rtype: NoneType