Deadline CLI Reference¶
deadline manifest¶
BETA - Commands to work with Deadline Cloud job attachments.
Usage:
deadline manifest [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message and exit.
diff¶
BETA - Compute the file difference of a root directory against an existing job attachments manifest for new, modified or deleted files.
Usage:
deadline manifest diff [OPTIONS]
Options:
--root TEXT The root directory to compare changes to.
--manifest TEXT The path to manifest file to diff against.
[required]
-i, --include TEXT Glob syntax of files and directories to
include in the manifest. Can be provided
multiple times.
-e, --exclude TEXT Glob syntax of files and directories to
exclude in the manifest. Can be provided
multiple times.
-ie, --include-exclude-config TEXT
Include and exclude config of files and
directories to include and exclude. Can be a
json file or json string.
--force-rehash Rehash all files to compare using file
hashes.
--json Output is printed as JSON for scripting.
--help Show this message and exit.
download¶
BETA - Download job attachments Manifests for a Job, or Step including dependencies.
Usage:
deadline manifest download [OPTIONS] DOWNLOAD_DIR
Options:
--profile TEXT The AWS profile to use.
--job-id TEXT The AWS Deadline Cloud Job to get.
[required]
--step-id TEXT The AWS Deadline Cloud Step to get.
--farm-id TEXT The AWS Deadline Cloud Farm to use.
--queue-id TEXT The AWS Deadline Cloud Queue to use.
--asset-type [input|output|all]
Which asset type to download: INPUT means
download only input asset files for given
job/step. OUTPUT means download only output
asset files for given job/step. ALL
(default) means download all input & output
asset files for given job/step.
--json Output is printed as JSON for scripting.
--help Show this message and exit.
snapshot¶
BETA - Generates a snapshot of files in a directory root as a job attachments Manifest.
Usage:
deadline manifest snapshot [OPTIONS]
Options:
--root TEXT The root directory to snapshot. [required]
-d, --destination TEXT Destination directory where manifest is
created. Defaults to the manifest root
directory.
-n, --name TEXT Name of the manifest. A timestamp is added
YYYY-MM-DD-HH-MM-SS for versioning.
-i, --include TEXT Glob syntax of files and directories to
include in the manifest. Can be provided
multiple times.
-e, --exclude TEXT Glob syntax of files and directories to
exclude in the manifest. Can be provided
multiple times.
-ie, --include-exclude-config TEXT
Include and exclude config of files and
directories to include and exclude. Can be a
json file or json string.
--force-rehash Rehash all files to compare using file
hashes.
--diff TEXT File Path to Asset Manifest to diff against.
--json Output is printed as JSON for scripting.
--help Show this message and exit.
upload¶
BETA - Uploads a job attachments manifest file to a Content Addressable Storage's Manifest store. If calling via --s3-cas-path, it is recommended to use with --profile for a specific AWS profile with CAS S3 bucket access. Check exit code for success or failure.
Usage:
deadline manifest upload [OPTIONS] MANIFEST_FILE
Options:
--profile TEXT The AWS profile to use.
--s3-cas-uri TEXT The URI to the Content Addressable Storage S3
bucket and root.
--s3-manifest-prefix TEXT Prefix subpath in the manifest folder to upload
the manifest.
--farm-id TEXT The AWS Deadline Cloud Farm to use. Alternative
to using --s3-cas-uri.
--queue-id TEXT The AWS Deadline Cloud Queue to use. Alternative
to using --s3-cas-uri.
--json Output is printed as JSON for scripting.
--help Show this message and exit.