runai-bgu CLI Manual

What is runai-bgu?

runai-bgu is a command-line interface (CLI) tool designed specifically for the BGU HPC cluster. It provides a simplified wrapper around the RunAI platform, making it easier to submit and manage computational jobs.

Key Features

  • Job Submission: Submit interactive and batch jobs using pre-configured container images

  • Resource Management: Easily specify CPU, memory, and GPU requirements

  • Template System: Save and reuse common resource configurations

  • Container Support: Built-in support for popular development environments (PyCharm, VSCode, Python, etc.)

  • Port Forwarding: Automatic port forwarding for remote development and access

Available Commands

The CLI provides several commands for different aspects of job management. Each command has its own dedicated documentation page:

  • bash: Access interactive shell in running jobs.

  • config: Set default project for runai-bgu commands.

  • delete: Remove jobs from the cluster.

  • describe: Get detailed information about specific jobs.

  • list: View running and completed jobs.

  • login: Log in to the cluster.

  • logout: Log out from the cluster.

  • logs: View job logs and output.

  • projects: List available projects.

  • resume: Resume paused jobs.

  • submit: Submit new jobs to the cluster.

  • template: Create and manage resource templates.

Getting Started

To get started with runai-bgu, you’ll typically want to:

  1. Log in to the cluster using the login command

  2. Submit your first job using one of the available images

  3. Monitor your job’s progress using the list and logs commands

For detailed instructions on each command, please refer to their respective documentation pages.