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

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

disable

Disable an existing compute environment.

beagle compute disable [OPTIONS] COMPUTE_ENVIRONMENT

Arguments

COMPUTE_ENVIRONMENT

Required argument

update

Update an existing compute environment.

beagle compute update [OPTIONS] COMPUTE_ENVIRONMENT

Arguments

COMPUTE_ENVIRONMENT

Required argument

info

beagle info [OPTIONS]

job

Sub-command for building and managing Batch job descriptiouns and jobs.

beagle job [OPTIONS] COMMAND [ARGS]...

cancel

Cancel all jobs.

beagle job cancel [OPTIONS] QUEUE

Arguments

QUEUE

Required argument

create

Create a new job description.

beagle job create [OPTIONS] JOB_DESCRIPTION

Arguments

JOB_DESCRIPTION

Required argument

deregister

Deregister an existing job description. :param ctx: :param job_description: :return:

beagle job deregister [OPTIONS] JOB_DESCRIPTION

Arguments

JOB_DESCRIPTION

Required argument

list

List running jobs.

beagle job list [OPTIONS] QUEUE

Arguments

QUEUE

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_DESCRIPTION QUEUE

Options

-p, --parameters <parameters>

Path to the parameters file.

Arguments

NAME

Required argument

JOB_DESCRIPTION

Required argument

QUEUE

Required argument

terminate

Terminate all jobs.

beagle job terminate [OPTIONS] QUEUE

Arguments

QUEUE

Required argument

update

Update an existing job description.

beagle job update [OPTIONS] JOB_DESCRIPTION

Arguments

JOB_DESCRIPTION

Required argument

queue

Sub-command for building and managing queues.

beagle queue [OPTIONS] COMMAND [ARGS]...

create

Create a new queue.

beagle queue create [OPTIONS] QUEUE

Arguments

QUEUE

Required argument

destroy

Destroy an existing queue.

beagle queue destroy [OPTIONS] QUEUE

Arguments

QUEUE

Required argument

disable

Disable an existing queue.

beagle queue disable [OPTIONS] QUEUE

Arguments

QUEUE

Required argument

update

Update an existing queue.

beagle queue update [OPTIONS] QUEUE

Arguments

QUEUE

Required argument