Command-line reference¶
beagle¶
Configure and deploy AWS Batch jobs.
beagle [OPTIONS] COMMAND [ARGS]...
Options
-
-f
,
--filename
<filename>
¶ Path to the config file. Default: ./batchbeagle.yml
-
-i
,
--import_env
,
--no-import_env
¶
Whether or not to load environment variables from the host
assemble¶
Assemble (create/update) all Job Descriptions, Job Queues and Compute Environments in a config file :param ctx: :return:
beagle assemble [OPTIONS]
compute¶
Sub-command for building and managing Batch compute environments.
beagle compute [OPTIONS] COMMAND [ARGS]...
create¶
Create a new compute environment.
beagle compute create [OPTIONS] COMPUTE_ENVIRONMENT
Arguments
-
COMPUTE_ENVIRONMENT
¶
Required argument
destroy¶
Destroy an existing compute environment.
beagle compute destroy [OPTIONS] COMPUTE_ENVIRONMENT
Arguments
-
COMPUTE_ENVIRONMENT
¶
Required argument
info¶
beagle info [OPTIONS]
job¶
Sub-command for building and managing Batch job definitions and jobs.
beagle job [OPTIONS] COMMAND [ARGS]...
create¶
Create a new job definition.
beagle job create [OPTIONS] JOB_DEFINITION
Arguments
-
JOB_DEFINITION
¶
Required argument
deregister¶
Deregister an existing job definition. :param ctx: :param job_definition: :return:
beagle job deregister [OPTIONS] JOB_DEFINITION
Arguments
-
JOB_DEFINITION
¶
Required argument
submit¶
Submit jobs to AWS Batch. Each line of the parameters file will result in a job.
beagle job submit [OPTIONS] NAME JOB_DEFINITION QUEUE
Options
-
-p
,
--parameters
<parameters>
¶ Path to the parameters file.
-
--nowait
¶
Do not wait for all jobs to start running
Arguments
-
NAME
¶
Required argument
-
JOB_DEFINITION
¶
Required argument
-
QUEUE
¶
Required argument
queue¶
Sub-command for building and managing queues.
beagle queue [OPTIONS] COMMAND [ARGS]...
destroy¶
Destroy an existing queue.
beagle queue destroy [OPTIONS] QUEUE
Arguments
-
QUEUE
¶
Required argument
teardown¶
Teardown (destroy/deregister) all Job Descriptions, Job Queues and Compute Environments in a config file :param ctx: :return:
beagle teardown [OPTIONS]