Skip to main content

Commands

Usage

bx [-hV] [COMMAND]

Parameters and inputs

ShorthandLong versionDescription
--helpShow this help message and exit
-V--versionPrint version information and exit

Examples

Display available commands

$ bx
Usage: bx [-hV] [COMMAND]
Run and share batch workloads in the BatchX cloud
-h, --help Show this help message and exit.
-V, --version Print version information and exit.
Commands:
whoami Show information about the logged user
env Switch or show environment information
add-token Add a connection token for a third-party server
import Import a Docker image into BatchX
images List imported images
image Show image information
rmi Delete an image
submit Schedule a job to run in BatchX
attach Attach local standard output and error streams to a running job
run Submit and attach at once
resubmit Retry a past job
rerun Resubmit and attach
cancel Cancel a running job
rmj Delete a job
logs Retrieve job logs
run-local Run a Docker image locally
jobs List jobs
job Show jobs details
ls List information about the files in your BatchX file-system
cat Stream BatchX file contents to standard output
rm Remove a file or folder from your BatchX file-system
cp Copy files to/from your BatchX file-system
tree Show the file-system structure under a specified folder

Command categories:

File System Commands

Image Commands

Job Commands

Misc Commands