AnchoreCTL (anchorectl) is the command-line client for Anchore Enterprise. Every
function available in the Anchore Enterprise UI is built on the same APIs that
AnchoreCTL calls, so anything you can do in the browser you can also do from a
terminal or a CI pipeline.
This is the complete reference for the AnchoreCTL command set: every command group,
every subcommand, and every flag with its environment variable and default. Each
top-level command group has its own page; the Command Index below
links to every individual command. It describes AnchoreCTL
v6.3.2; run anchorectl version to check yours.
AnchoreCTL reads its settings from a configuration file, environment variables, and
command-line flags, in ascending order of precedence. This page documents the flags;
for the configuration file and the full list of ANCHORECTL_* variables, see
Configuring AnchoreCTL.
Related Pages
Deploying AnchoreCTL — download and
install the binary for Linux, macOS, or Windows.
Configuring AnchoreCTL — the
configuration file, environment variables, and how settings are resolved.
Arguments shown in UPPER_CASE in a command synopsis are positional and required.
Anything in [square brackets] is optional. A trailing ..., as in
anchorectl image delete IMAGE..., means the argument can be repeated.
In the flag tables on each page, the Flag column shows exactly what you type and
the Type column shows the kind of value it takes:
Type
Meaning
bool
Takes no value. The flag’s presence turns it on, as in --wait.
string
Takes one value, as in --output json.
string (repeatable)
Takes one value and may be given more than once, as in --annotation owner=platform-team --annotation commit=a3f7c01.
int
Takes a whole number, as in --timeout 300.
count
Takes no value; repeat it to increase the effect, as in -vv.
Global Flags
These four flags are accepted by every command.
Flag
Type
Environment variable
Default
Required
Description
-c, --config
string
ANCHORECTL_CONFIG
""
No
Path to the AnchoreCTL configuration file. Bypasses the default search order.
-h, --help
bool
—
false
No
Show help for the command and exit.
-q, --quiet
bool
ANCHORECTL_QUIET
false
No
Suppress all logging output. Results are still written to stdout.
The settings that connect you to Anchore Enterprise — url, username, password,
and account — have no command-line flags at all. Set them in the configuration file
or through ANCHORECTL_URL, ANCHORECTL_USERNAME, ANCHORECTL_PASSWORD, and
ANCHORECTL_ACCOUNT. See Configuring AnchoreCTL.
registry add --username and user add --account are unrelated flags with their own
variables — the registry’s credential and the new user’s account.
Output Formats
-o/--output selects how results are printed. It is not a global flag — it is
defined per command, on 137 of the 159 commands, and the root command does not accept
it at all. Values and defaults differ per command; each command’s flag table lists
what it accepts. ANCHORECTL_FORMAT sets it on most of them, though
anchorectl image sbom, anchorectl version, and the add and update commands
under anchorectl system artifact-lifecycle-policy (including its images and
app-versions subcommands) ignore the variable and need the flag passed
explicitly.
The app version export commands and app export apps-by-vulnerability are the main
exception. They emit a document rather than a result listing, so they take --format
for the document format and --file to write it to disk instead of stdout. anchorectl image one-time-scan likewise uses
--format together with --output-directory.
Value
Description
text
Human-readable table. The default for most commands.
json
Structured JSON, normalized by AnchoreCTL.
json-raw
The unmodified JSON response from the Anchore Enterprise API. Use this when you need fields AnchoreCTL does not surface.
id
The identifier of the affected object only. Useful for shell pipelines.
csv
Comma-separated values, for export commands.
html
Self-contained HTML report. Set ui-url in your configuration to make the report link back to the Anchore Enterprise UI.
cyclonedx-json
CycloneDX document in JSON form.
cyclonedx-xml
CycloneDX document in XML form.
spdx-json
SPDX document in JSON form.
spdx-tag-value
SPDX document in tag-value form.
syft-json
Syft’s native JSON SBOM format. The default for anchorectl image sbom.
purls
A plain list of Package URLs.
table
Syft’s table rendering of an SBOM.
--output-directory — available on anchorectl image check,
anchorectl image vulnerabilities, and anchorectl image one-time-scan — accepts
only json, json-raw, html, and csv. Any other value, including the default
text, fails with output directory can only be used with json, json-raw, html, or csv output format.
On anchorectl image vulnerabilities, the cyclonedx-json and cyclonedx-xml
formats require an image digest. Passing a tag fails with
digest required to call GetImage.
Exit Codes
Code
Meaning
0
The command ran successfully.
1
The command failed — a request error, invalid input, or an unreachable server.
The exit code reflects whether the command itself ran, not the outcome of a policy
evaluation: a fail result is still a successful command and exits 0. To make a
failing evaluation break a CI build, pass -f/--fail-based-on-results to
anchorectl image check or anchorectl app version policy status get, or
--fail-on-policy-error to anchorectl image one-time-scan.
Command Index
Each page below documents that command’s complete subcommand tree, with every flag
and argument.
Every command on this page also accepts the global flags.
Subcommands
account add — Create a new account. Only available to admin user.
account delete — Delete the specified account, only allowed if the account is in the disabled state. All users will be deleted along with the account and all resources will be garbage collected
account get — Get info about an account. Only available to admin user. Uses the main user Id, not a username.
account list — List account summaries. Only available to the system admin user.
account update — Update an account. Only available to admin user.
account add
Create a new account. Only available to admin user.
anchorectl account add NAME [flags]
Arguments
Argument
Description
NAME
Name of the account to create.
Flags
Flag
Type
Environment variable
Default
Required
Description
--email
string
ANCHORECTL_ACCOUNT_EMAIL
""
No
The account email.
--organization-name
string
ANCHORECTL_ACCOUNT_ORGANIZATION_NAME
""
No
Human-readable organization name for the account. Defaults to the account name if not provided.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
account delete
Delete the specified account, only allowed if the account is in the disabled state. All users will be deleted along with the account and all resources will be garbage collected.
anchorectl account delete NAME [flags]
Aliases:del
Arguments
Argument
Description
NAME
Name of the account.
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
account disable
Disable an account.
anchorectl account disable NAME [flags]
Arguments
Argument
Description
NAME
Name of the account.
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
account enable
Enable a previously disabled account.
anchorectl account enable NAME [flags]
Arguments
Argument
Description
NAME
Name of the account.
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
account get
Get info about an account. Only available to admin user. Uses the main user Id, not a username.
anchorectl account get NAME [flags]
Arguments
Argument
Description
NAME
Name of account.
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
account list
List account summaries. Only available to the system admin user.
anchorectl account list [flags]
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
--state
string
ANCHORECTL_ACCOUNT_STATE
""
No
Filter accounts by state. Allowable values: enabled, disabled, deleting.
account update
Update an account. Only available to admin user.
anchorectl account update NAME [flags]
Arguments
Argument
Description
NAME
Name of the account.
Flags
Flag
Type
Environment variable
Default
Required
Description
--email
string
ANCHORECTL_ACCOUNT_EMAIL
""
No
The account email. Pass an empty string to clear it.
--organization-name
string
ANCHORECTL_ACCOUNT_ORGANIZATION_NAME
""
No
Human-readable organization name for the account. When omitted, the organization name is left unchanged.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
2 - anchorectl airgap
Airgap related operations.
Every command on this page also accepts the global flags.
Export the application versions across the account that are affected by a specific vulnerability. Creates an export job, waits for completion, and outputs the result.
The vulnerability ID to search on (e.g. CVE-2024-1234).
Examples
# Released versions affected by a CVE, written to a fileanchorectl app export apps-by-vulnerability CVE-2022-22965 --status released -f cve-2022-22965.csv
# Versions without a VEX annotation for the vulnerability, with a link column to the GUIanchorectl app export apps-by-vulnerability CVE-2022-22965 --annotation-status none \
--ui-base-url https://anchore.example.com
Filter by VEX annotation status; none matches app versions with no annotation (comma-separated; matches any of the given values). Allowable values: not_affected, affected, fixed, under_investigation, none.
--app-name
string (repeatable)
ANCHORECTL_APP_NAME
[]
No
Filter by application name (comma-separated; matches any of the given values).
--app-name-contains
string
ANCHORECTL_APP_NAME_CONTAINS
""
No
Filter to applications whose name contains this substring.
--app-version
string (repeatable)
ANCHORECTL_APP_VERSION
[]
No
Filter by app version name (comma-separated; matches any of the given values).
--app-version-contains
string
ANCHORECTL_APP_VERSION_CONTAINS
""
No
Filter to app versions whose name contains this substring.
--contact-email
string (repeatable)
ANCHORECTL_CONTACT_EMAIL
[]
No
Filter by application contact email (comma-separated; matches any of the given values).
--contact-name
string (repeatable)
ANCHORECTL_CONTACT_NAME
[]
No
Filter by application contact name (comma-separated; matches any of the given values).
--contact-org
string (repeatable)
ANCHORECTL_CONTACT_ORG
[]
No
Filter by application contact organization name (comma-separated; matches any of the given values).
-f, --file
string
ANCHORECTL_FILE
""
No
Write output to file instead of stdout.
--format
string
ANCHORECTL_FORMAT
csv
No
The export format. Allowable values: csv.
--has-fix
bool
ANCHORECTL_HAS_FIX
false
No
Filter to app versions where a fix is (--has-fix) or is not (--has-fix=false) available for the vulnerability.
--min-affected-packages
int
ANCHORECTL_MIN_AFFECTED_PACKAGES
0
No
Filter to app versions with at least this many affected packages.
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
app job get
Get a job by ID. Pass --detail with -o json-raw to fetch the type-specific job payload (job_spec, completion_detail, etc.).
anchorectl app job get JOB_ID [flags]
Arguments
Argument
Description
JOB_ID
The job UUID.
Flags
Flag
Type
Environment variable
Default
Required
Description
--app
string
ANCHORECTL_APP
""
Yes
The app name or ID.
--detail
bool
ANCHORECTL_DETAIL
false
No
Fetch the type-specific job payload (requires -o json-raw).
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
app job list
List jobs for an app.
anchorectl app job list APP [flags]
Arguments
Argument
Description
APP
The app name or ID.
Flags
Flag
Type
Environment variable
Default
Required
Description
--created-since
string
ANCHORECTL_CREATED_SINCE
""
No
Only show jobs created since: Go duration syntax (units s/m/h, e.g. “30m”, “1h”, “2h45m”, “1.5h”) or a datetime (“2026-04-15”, “2026-04-15 09:00:00”, “2026-04-15T09:00:00Z”). Bare datetimes are interpreted in local time.
--mine
bool
ANCHORECTL_MINE
false
No
Only show jobs owned by the current user.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
--status
string (repeatable)
ANCHORECTL_STATUS
[]
No
Filter by job status (comma-separated for multiple, OR semantics). Allowable values: pending, processing, cancelled, complete, failed.
--version
string
ANCHORECTL_VERSION
""
No
Filter by version name or UUID.
app list
List all apps.
anchorectl app list [flags]
Flags
Flag
Type
Environment variable
Default
Required
Description
--name
string
ANCHORECTL_NAME
""
No
Filter by exact app name.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
app update
Update an existing app.
anchorectl app update APP [flags]
Arguments
Argument
Description
APP
The app name or ID.
Flags
Flag
Type
Environment variable
Default
Required
Description
--contact-email
string
ANCHORECTL_CONTACT_EMAIL
""
No
Contact email address.
--contact-name
string
ANCHORECTL_CONTACT_NAME
""
No
Contact person name.
--contact-organization
string
ANCHORECTL_CONTACT_ORGANIZATION
""
No
The new organization name for the app’s contact; omit to leave it unchanged. Pass an empty string to clear it, so that the app uses the account’s organization name.
--contact-phone
string
ANCHORECTL_CONTACT_PHONE
""
No
Contact phone number.
--description
string
ANCHORECTL_DESCRIPTION
""
No
The new description.
--name
string
ANCHORECTL_NAME
""
No
The new name for the app.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
# Create a released version of an appanchorectl app version add 1.4.0 --app my-service --status released
# Create the next version and chain it to its predecessoranchorectl app version add 1.5.0 --app my-service --status in_progress --previous-version 1.4.0
Flags
Flag
Type
Environment variable
Default
Required
Description
--app
string
ANCHORECTL_APP
""
Yes
The app name or ID.
--description
string
ANCHORECTL_DESCRIPTION
""
No
The version description.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
--previous-version
string
ANCHORECTL_PREVIOUS_VERSION
""
No
The previous version name or UUID.
--release-date
string
ANCHORECTL_RELEASE_DATE
""
No
Date of release of this version (e.g. 2026-01-15).
--status
string
ANCHORECTL_STATUS
""
No
The status of the app version (in_progress, released, eol).
app version asset add analysis-bundle — Upload an analysis bundle produced by anchorectl generate analysis-bundle as an asset to an app version. Creates a job to import and process the analysis.
app version asset add container-image — Add a container image as an asset. By default pulls from a registry. Use --from docker or --from podman to analyze a local daemon image, or --from docker-archive:/path/to.tar to load from an archive.
app version asset add filesystem — Add a filesystem directory as an asset. Analyzes the directory locally using Syft, generates an SBOM, and uploads it to Enterprise.
app version asset add sbom — Upload an SBOM file as an asset to an app version. Creates a job to import and process the SBOM.
app version asset add analysis-bundle
Upload an analysis bundle produced by anchorectl generate analysis-bundle as an asset to an app version. Creates a job to import and process the analysis.
anchorectl app version asset add analysis-bundle BUNDLE [flags]
Arguments
Argument
Description
BUNDLE
Path to the analysis bundle tar archive (uncompressed; typically named .tar).
Flags
Flag
Type
Environment variable
Default
Required
Description
--app
string
ANCHORECTL_APP
""
Yes
The app name or ID.
--asset
string
ANCHORECTL_ASSET
""
Yes
The name for the new asset.
--version
string
ANCHORECTL_VERSION
""
Yes
The version name or UUID.
-a, --annotations
string
ANCHORECTL_ANNOTATIONS
""
No
Annotations as comma-separated key=value pairs.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
--timeout
int
ANCHORECTL_TIMEOUT
1800
No
With --wait, the number of seconds to wait for the job before giving up. A negative value waits until the job finishes.
-t, --type
string
ANCHORECTL_TYPE
unknown
No
The asset type (image analysis bundles default to container).
-w, --wait
bool
ANCHORECTL_WAIT
false
No
Wait for the job to complete before returning.
app version asset add container-image
Add a container image as an asset. By default pulls from a registry. Use --from docker or --from podman to analyze a local daemon image, or --from docker-archive:/path/to.tar to load from an archive.
anchorectl app version asset add container-image IMAGE [flags]
Arguments
Argument
Description
IMAGE
The container image reference (e.g. docker.io/library/nginx:latest).
Flags
Flag
Type
Environment variable
Default
Required
Description
--app
string
ANCHORECTL_APP
""
Yes
The app name or ID.
--asset
string
ANCHORECTL_ASSET
""
Yes
The name for the new asset.
--version
string
ANCHORECTL_VERSION
""
Yes
The version name or UUID.
-a, --annotations
string
ANCHORECTL_ANNOTATIONS
""
No
Annotations as comma-separated key=value pairs.
--dockerfile
string
ANCHORECTL_DOCKERFILE
""
No
Path to the Dockerfile used to build the image.
--from
string
ANCHORECTL_FROM
""
No
Image source: registry (default), docker, podman, or docker-archive:<path> (podman requires a running Podman API service; set CONTAINER_HOST for a specific or remote socket) (docker and podman: if the image is not present in the daemon it is pulled from the registry).
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
-p, --platform
string
ANCHORECTL_PLATFORM
""
No
Platform specifier (e.g. linux/amd64).
--timeout
int
ANCHORECTL_TIMEOUT
1800
No
With --wait, the number of seconds to wait for the job before giving up. A negative value waits until the job finishes.
-t, --type
string
ANCHORECTL_TYPE
container
No
The asset type.
-w, --wait
bool
ANCHORECTL_WAIT
false
No
Wait for the job to complete before returning.
app version asset add container-image-remote
Add a container image via centralized analysis. Enterprise pulls and analyzes the image from the registry.
anchorectl app version asset add container-image-remote IMAGE [flags]
Arguments
Argument
Description
IMAGE
The container image reference (e.g. docker.io/library/nginx:latest).
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
--timeout
int
ANCHORECTL_TIMEOUT
1800
No
With --wait, the number of seconds to wait for the job before giving up. A negative value waits until the job finishes.
-t, --type
string
ANCHORECTL_TYPE
container
No
The asset type.
-w, --wait
bool
ANCHORECTL_WAIT
false
No
Wait for the job to complete before returning.
app version asset add filesystem
Add a filesystem directory as an asset. Analyzes the directory locally using Syft, generates an SBOM, and uploads it to Enterprise.
anchorectl app version asset add filesystem DIRECTORY [flags]
Arguments
Argument
Description
DIRECTORY
The path to the directory to analyze (e.g. /mnt/unpacked-vm, ./myapp).
Flags
Flag
Type
Environment variable
Default
Required
Description
--app
string
ANCHORECTL_APP
""
Yes
The app name or ID.
--asset
string
ANCHORECTL_ASSET
""
Yes
The name for the new asset.
--version
string
ANCHORECTL_VERSION
""
Yes
The version name or UUID.
-a, --annotations
string
ANCHORECTL_ANNOTATIONS
""
No
Annotations as comma-separated key=value pairs.
--author
string
ANCHORECTL_AUTHOR
unknown
No
SBOM document author (e.g. “Name <email>”).
--exclude
string (repeatable)
ANCHORECTL_EXCLUDE
[]
No
Exclude paths from the scan using glob expressions relative to the scan root, as a comma-separated list or a repeated flag. Each pattern must start with ./, */, or **/ (e.g. --exclude './vendor,**/node_modules'). When given, replaces the exclude list from the configuration file.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
--supplier
string
ANCHORECTL_SUPPLIER
unknown
No
SBOM document supplier name.
--timeout
int
ANCHORECTL_TIMEOUT
1800
No
With --wait, the number of seconds to wait for the job before giving up. A negative value waits until the job finishes.
-t, --type
string
ANCHORECTL_TYPE
filesystem
No
The asset type.
-w, --wait
bool
ANCHORECTL_WAIT
false
No
Wait for the job to complete before returning.
app version asset add sbom
Upload an SBOM file as an asset to an app version. Creates a job to import and process the SBOM.
anchorectl app version asset add sbom SBOM_FILE [flags]
Arguments
Argument
Description
SBOM_FILE
Path to the SBOM file.
Flags
Flag
Type
Environment variable
Default
Required
Description
--app
string
ANCHORECTL_APP
""
Yes
The app name or ID.
--asset
string
ANCHORECTL_ASSET
""
Yes
The name for the new asset.
--version
string
ANCHORECTL_VERSION
""
Yes
The version name or UUID.
-a, --annotations
string
ANCHORECTL_ANNOTATIONS
""
No
Annotations as comma-separated key=value pairs.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
--timeout
int
ANCHORECTL_TIMEOUT
1800
No
With --wait, the number of seconds to wait for the job before giving up. A negative value waits until the job finishes.
-t, --type
string
ANCHORECTL_TYPE
unknown
No
The asset type.
-w, --wait
bool
ANCHORECTL_WAIT
false
No
Wait for the job to complete before returning.
app version asset delete
Delete an asset from an app version.
anchorectl app version asset delete ASSET [flags]
Arguments
Argument
Description
ASSET
The asset name or UUID.
Flags
Flag
Type
Environment variable
Default
Required
Description
--app
string
ANCHORECTL_APP
""
Yes
The app name or ID.
--version
string
ANCHORECTL_VERSION
""
Yes
The version name or UUID.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
app version asset get
Get an asset by ID for an app version.
anchorectl app version asset get ASSET [flags]
Arguments
Argument
Description
ASSET
The asset name or UUID.
Flags
Flag
Type
Environment variable
Default
Required
Description
--app
string
ANCHORECTL_APP
""
Yes
The app name or ID.
--version
string
ANCHORECTL_VERSION
""
Yes
The version name or UUID.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
app version asset list
List assets for an app version.
anchorectl app version asset list VERSION [flags]
Arguments
Argument
Description
VERSION
The version name or UUID.
Flags
Flag
Type
Environment variable
Default
Required
Description
--app
string
ANCHORECTL_APP
""
Yes
The app name or ID.
--name
string
ANCHORECTL_NAME
""
No
Filter by asset name.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
anchorectl app version asset sbom get ASSET [flags]
Arguments
Argument
Description
ASSET
The asset name or UUID.
Flags
Flag
Type
Environment variable
Default
Required
Description
--app
string
ANCHORECTL_APP
""
Yes
The app name or ID.
--version
string
ANCHORECTL_VERSION
""
Yes
The version name or UUID.
-f, --file
string
ANCHORECTL_FILE
""
No
Write SBOM to file instead of stdout.
app version asset update
Update an asset for an app version.
anchorectl app version asset update ASSET [flags]
Arguments
Argument
Description
ASSET
The asset name or UUID.
Flags
Flag
Type
Environment variable
Default
Required
Description
--app
string
ANCHORECTL_APP
""
Yes
The app name or ID.
--version
string
ANCHORECTL_VERSION
""
Yes
The version name or UUID.
--annotations
string
ANCHORECTL_ANNOTATIONS
""
No
Annotations as comma-separated key=value pairs (merge with existing, set value to empty to remove).
--name
string
ANCHORECTL_NAME
""
No
The new name for the asset.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
--type
string
ANCHORECTL_TYPE
""
No
The asset type.
app version delete
Delete an app version by name or ID.
anchorectl app version delete VERSION [flags]
Aliases:del
Arguments
Argument
Description
VERSION
The version name or UUID.
Flags
Flag
Type
Environment variable
Default
Required
Description
--app
string
ANCHORECTL_APP
""
Yes
The app name or ID.
--force
bool
ANCHORECTL_FORCE
false
No
Force delete (removes all associations).
app version export
Export documents for an app version.
anchorectl app version export [command]
Subcommands
app version export packages — Export package data for an app version. Creates an export job, waits for completion, and outputs the result.
app version export policy-compliance — Export policy compliance findings for an app version. Creates an export job, waits for completion, and outputs the result.
app version export sbom-cyclonedx-1 — Export a combined CycloneDX 1.x JSON SBOM for an app version. Creates an export job, waits for completion, and outputs the result.
app version export sbom-spdx-2 — Export a combined SPDX 2.x JSON SBOM for an app version. Creates an export job, waits for completion, and outputs the result.
app version export vdr — Export a CycloneDX VDR (Vulnerability Disclosure Report) for an app version. Creates an export job, waits for completion, and outputs the result.
app version export vex — Export VEX (Vulnerability Exploitability eXchange) annotations for an app version. Creates an export job, waits for completion, and outputs the result.
app version export vulnerabilities — Export vulnerability data for an app version. Creates an export job, waits for completion, and outputs the result.
app version export packages
Export package data for an app version. Creates an export job, waits for completion, and outputs the result.
anchorectl app version export packages VERSION [flags]
Arguments
Argument
Description
VERSION
The version name or UUID.
Flags
Flag
Type
Environment variable
Default
Required
Description
--app
string
ANCHORECTL_APP
""
Yes
The app name or ID.
-f, --file
string
ANCHORECTL_FILE
""
No
Write output to file instead of stdout.
--format
string
ANCHORECTL_FORMAT
csv
No
The export format. Allowable values: csv.
app version export policy-compliance
Export policy compliance findings for an app version. Creates an export job, waits for completion, and outputs the result.
anchorectl app version export policy-compliance VERSION [flags]
Arguments
Argument
Description
VERSION
The version name or UUID.
Flags
Flag
Type
Environment variable
Default
Required
Description
--app
string
ANCHORECTL_APP
""
Yes
The app name or ID.
-f, --file
string
ANCHORECTL_FILE
""
No
Write output to file instead of stdout.
--format
string
ANCHORECTL_FORMAT
csv
No
The export format. Allowable values: csv.
app version export sbom-cyclonedx-1
Export a combined CycloneDX 1.x JSON SBOM for an app version. Creates an export job, waits for completion, and outputs the result.
anchorectl app version export sbom-cyclonedx-1 VERSION [flags]
Arguments
Argument
Description
VERSION
The version name or UUID.
Flags
Flag
Type
Environment variable
Default
Required
Description
--app
string
ANCHORECTL_APP
""
Yes
The app name or ID.
-f, --file
string
ANCHORECTL_FILE
""
No
Write output to file instead of stdout.
app version export sbom-spdx-2
Export a combined SPDX 2.x JSON SBOM for an app version. Creates an export job, waits for completion, and outputs the result.
anchorectl app version export sbom-spdx-2 VERSION [flags]
Arguments
Argument
Description
VERSION
The version name or UUID.
Flags
Flag
Type
Environment variable
Default
Required
Description
--app
string
ANCHORECTL_APP
""
Yes
The app name or ID.
-f, --file
string
ANCHORECTL_FILE
""
No
Write output to file instead of stdout.
app version export vdr
Export a CycloneDX VDR (Vulnerability Disclosure Report) for an app version. Creates an export job, waits for completion, and outputs the result.
anchorectl app version export vdr VERSION [flags]
Arguments
Argument
Description
VERSION
The version name or UUID.
Flags
Flag
Type
Environment variable
Default
Required
Description
--app
string
ANCHORECTL_APP
""
Yes
The app name or ID.
-f, --file
string
ANCHORECTL_FILE
""
No
Write output to file instead of stdout.
--format
string
ANCHORECTL_FORMAT
cyclonedx-json
No
The export format. Allowable values: cyclonedx-json.
app version export vex
Export VEX (Vulnerability Exploitability eXchange) annotations for an app version. Creates an export job, waits for completion, and outputs the result.
anchorectl app version export vex VERSION [flags]
Arguments
Argument
Description
VERSION
The version name or UUID.
Flags
Flag
Type
Environment variable
Default
Required
Description
--app
string
ANCHORECTL_APP
""
Yes
The app name or ID.
-f, --file
string
ANCHORECTL_FILE
""
No
Write output to file instead of stdout.
--format
string
ANCHORECTL_FORMAT
cyclonedx-json
No
The export format. Allowable values: cyclonedx-json.
app version export vulnerabilities
Export vulnerability data for an app version. Creates an export job, waits for completion, and outputs the result.
anchorectl app version export vulnerabilities VERSION [flags]
Arguments
Argument
Description
VERSION
The version name or UUID.
Flags
Flag
Type
Environment variable
Default
Required
Description
--app
string
ANCHORECTL_APP
""
Yes
The app name or ID.
-f, --file
string
ANCHORECTL_FILE
""
No
Write output to file instead of stdout.
--format
string
ANCHORECTL_FORMAT
csv
No
The export format. Allowable values: csv.
app version get
Get an app version by name or ID.
anchorectl app version get VERSION [flags]
Arguments
Argument
Description
VERSION
The version name or UUID.
Flags
Flag
Type
Environment variable
Default
Required
Description
--app
string
ANCHORECTL_APP
""
Yes
The app name or ID.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
app version list
List all versions of an app.
anchorectl app version list APP [flags]
Arguments
Argument
Description
APP
The app name or ID.
Flags
Flag
Type
Environment variable
Default
Required
Description
--name
string
ANCHORECTL_NAME
""
No
Filter by exact version name.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
The type of transition to make. If “archive”, then archive an image from the working set and remove it from the working set. If “delete”, then match against archived images and delete from the archive if match. Allowable values: archive, delete.
--analysis-age-days
int
ANCHORECTL_ARCHIVE_RULE_ANALYSIS_AGE_DAYS
0
No
Matches if the analysis is strictly older than this number of days.
--exclude-expiration-days
int
ANCHORECTL_ARCHIVE_RULE_EXCLUDE_EXPIRATION_DAYS
0
No
How long the image selected will be excluded from the archive transition.
--exclude-last-seen-in-days
int
ANCHORECTL_ARCHIVE_RULE_EXCLUDE_LAST_SEEN_IN_DAYS
0
No
Exclude image from archive if last seen in inventory within defined number of days.
--exclude-selector-registry
string
ANCHORECTL_ARCHIVE_RULE_EXCLUDE_SELECTOR_REGISTRY
""
No
The registry section of a pull string. e.g. with “docker.io/anchore/anchore-engine:latest”, this is “docker.io”.
The repository section of a pull string. e.g. with “docker.io/anchore/anchore-engine:latest”, this is “anchore/anchore-engine”.
--exclude-selector-tag
string
ANCHORECTL_ARCHIVE_RULE_EXCLUDE_SELECTOR_TAG
""
No
The tag-only section of a pull string. e.g. with “docker.io/anchore/anchore-engine:latest”, this is “latest”.
-i, --input
string
ANCHORECTL_INPUT
""
No
Path to a JSON input file or - to read from stdin.
--max-images-per-account
int
ANCHORECTL_ARCHIVE_RULE_MAX_IMAGES_PER_ACCOUNT
0
No
This is the maximum number of image analyses an account can have. Can only be set on system_global rules.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
--rule-id
string
ANCHORECTL_ARCHIVE_RULE_RULE_ID
""
No
Unique identifier for archive rule.
--selector-registry
string
ANCHORECTL_ARCHIVE_RULE_SELECTOR_REGISTRY
*
No
The registry section of a pull string. e.g. with “docker.io/anchore/anchore-engine:latest”, this is “docker.io”.
--selector-repository
string
ANCHORECTL_ARCHIVE_RULE_SELECTOR_REPOSITORY
*
No
The repository section of a pull string. e.g. with “docker.io/anchore/anchore-engine:latest”, this is “anchore/anchore-engine”.
--selector-tag
string
ANCHORECTL_ARCHIVE_RULE_SELECTOR_TAG
*
No
The tag-only section of a pull string. e.g. with “docker.io/anchore/anchore-engine:latest”, this is “latest”.
--system-global
bool
ANCHORECTL_ARCHIVE_RULE_SYSTEM_GLOBAL
false
No
True if the rule applies to all accounts in the system. This is only available to admin users to update/modify, but all users with permission to list rules can see them.
--tag-versions-newer
int
ANCHORECTL_ARCHIVE_RULE_TAG_VERSIONS_NEWER
0
No
Number of images mapped to the tag that are newer.
archive rule delete
Delete an analysis archive rule.
anchorectl archive rule delete ID [flags]
Aliases:del
Arguments
Argument
Description
ID
The rule id.
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
archive rule get
Get an analysis archive rule.
anchorectl archive rule get ID [flags]
Arguments
Argument
Description
ID
The rule id.
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
archive rule list
List the analysis archive rules.
anchorectl archive rule list [flags]
Flags
Flag
Type
Environment variable
Default
Required
Description
--global
bool
ANCHORECTL_ARCHIVE_RULE_GLOBAL
true
No
Include system global rules (owned by admin) even for non-admin users.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
5 - anchorectl auth
Auth related operations for the current user.
Every command on this page also accepts the global flags.
event list — Returns a paginated list of events in the descending order of their occurrence. Optional query parameters may be used for filtering results
event delete
Delete an event by its event ID or set of filters.
anchorectl event delete EVENT_ID [flags]
Aliases:del
Arguments
Argument
Description
EVENT_ID
Id of event to delete.
Flags
Flag
Type
Environment variable
Default
Required
Description
--all
bool
—
false
No
Delete all events.
--before
string
ANCHORECTL_EVENT_BEFORE
""
No
Delete events that occurred before the timestamp.
--force
bool
ANCHORECTL_EVENT_FORCE
false
No
Force without prompt.
--level
string
ANCHORECTL_EVENT_LEVEL
""
No
Delete events that match the level - INFO or ERROR.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
--since
string
ANCHORECTL_EVENT_SINCE
""
No
Delete events that occurred after the timestamp.
event get
Lookup an event by its event ID.
anchorectl event get ID [flags]
Arguments
Argument
Description
ID
Event ID of the event for lookup.
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
event list
Returns a paginated list of events in the descending order of their occurrence. Optional query parameters may be used for filtering results.
anchorectl event list [flags]
Flags
Flag
Type
Environment variable
Default
Required
Description
--all
bool
ANCHORECTL_EVENT_ALL
false
No
Return all events.
--before
string
ANCHORECTL_EVENT_BEFORE
""
No
Return events that occurred before the ISO8601 formatted UTC timestamp.
--event-type
string
ANCHORECTL_EVENT_TYPE
""
No
Filter events by a prefix match on the event type (e.g. “user.image.”).
--host
string
ANCHORECTL_EVENT_SOURCE_HOST_ID
""
No
Filter events by the originating host ID.
--level
string
ANCHORECTL_EVENT_LEVEL
""
No
Filter events by the level - INFO or ERROR.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
--page
int
ANCHORECTL_PAGE
0
No
Return the nth page of results starting from 1. Defaults to first page if left empty.
--resource-id
string
ANCHORECTL_EVENT_RESOURCE_ID
""
No
Filter events by a specified resource ID.
--resource-type
string
ANCHORECTL_EVENT_RESOURCE_TYPE
""
No
Filter events by the type of resource - tag, imageDigest, repository etc.
--service
string
ANCHORECTL_EVENT_SOURCE_SERVICE_NAME
""
No
Filter events by the originating service.
--since
string
ANCHORECTL_EVENT_SINCE
""
No
Return events that occurred after the ISO8601 formatted UTC timestamp.
9 - anchorectl feed
Feed related operations.
Every command on this page also accepts the global flags.
Subcommands
feed list — Return a list of feed and their groups along with update and record count information. This data reflects the state of the policy engine, not the upstream feed service itself.
feed sync — Execute a synchronous update all the datasets. The response will block until complete.
feed list
Return a list of feed and their groups along with update and record count information. This data reflects the state of the policy engine, not the upstream feed service itself.
anchorectl feed list [flags]
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
feed sync
Execute a synchronous update all the datasets. The response will block until complete.
anchorectl feed sync [flags]
Flags
Flag
Type
Environment variable
Default
Required
Description
-f, --force_sync
bool
ANCHORECTL_FORCE_SYNC
false
No
Force the feed sync to occur.
-t, --timeout
int
ANCHORECTL_TIMEOUT
-1
No
The maximum time to wait for the feed sync to complete.
10 - anchorectl generate
Generate analysis artifacts locally.
Every command on this page also accepts the global flags.
generate analysis-bundle filesystem — Generate an analysis bundle (an uncompressed tar archive containing the SBOM) for a local filesystem directory
generate analysis-bundle image — Run a full local analysis of a container image (SBOM, secrets, content search, file contents, manifests) and package the result set into an analysis bundle for later upload with app version asset add analysis.
generate analysis-bundle filesystem
Generate an analysis bundle (an uncompressed tar archive containing the SBOM) for a local filesystem directory.
File to write the analysis bundle tar archive (uncompressed; typically named .tar).
--exclude
string (repeatable)
ANCHORECTL_EXCLUDE
[]
No
Exclude paths from the scan using glob expressions relative to the scan root, as a comma-separated list or a repeated flag. Each pattern must start with ./, */, or **/ (e.g. --exclude './vendor,**/node_modules'). When given, replaces the exclude list from the configuration file.
-o, --output
string
ANCHORECTL_FORMAT
syft-json
No
The SBOM format inside the bundle, options: cyclonedx-json, cyclonedx-xml, spdx-json, spdx-tag-value, syft-json. See Output Formats.
--overwrite
bool
ANCHORECTL_OVERWRITE
false
No
Overwrite the output file if it exists.
generate analysis-bundle image
Run a full local analysis of a container image (SBOM, secrets, content search, file contents, manifests) and package the result set into an analysis bundle for later upload with app version asset add analysis.
Write the analysis bundle tar archive to this file.
--from
string
ANCHORECTL_FROM
""
No
The image source: registry (default), docker, podman, or docker-archive:<path> (docker and podman: if the image is not present in the daemon it is pulled from the registry).
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json. See Output Formats.
--overwrite
bool
ANCHORECTL_OVERWRITE
false
No
Overwrite the output file if it exists.
--platform
string
ANCHORECTL_PLATFORM
""
No
Platform to analyze for multi-arch images, e.g. linux/amd64.
11 - anchorectl image
Image related operations.
Every command on this page also accepts the global flags.
The container image to analyze (e.g. docker.io/library/nginx:latest).
Examples
# Submit image for addition to Anchore Enterprise (Anchore Enterprise will pull# image from registry and perform full analysis)anchorectl image add ghcr.io/place/thing:v0.1.0
# Submit image for addition to Anchore Enterprise (anchorectl will perform full# local image analysis, SBOM + additional analysis pushed to Anchore Enterprise)anchorectl image add ghcr.io/place/thing:v0.1.0 --from docker
# Analyze an image from a local podman daemon and push results to Anchore# Enterprise (falls back to the registry if the image is not in the daemon).# Requires the podman API service to be running, e.g.:# systemctl --user enable --now podman.socket# To target a non-default or remote daemon, set CONTAINER_HOST, e.g.:# export CONTAINER_HOST=ssh://user@host/run/podman/podman.sockanchorectl image add ghcr.io/place/thing:v0.1.0 --from podman
# Submit image for addition to Anchore Enterprise (use SBOM generated by Syft,# no additional analysis performed, and push to Anchore Enterprise)syft -o json ghcr.io/place/thing:v0.1.0 | anchorectl image add ghcr.io/place/thing:v0.1.0 --from -
# Submit and wait for analysis to completeanchorectl image add ghcr.io/place/thing:v0.1.0 --wait
# Submit and get results once analysis is completedanchorectl image add ghcr.io/place/thing:v0.1.0 --get content,vulnerabilities=/path/to/vulns.json
# Submit and fetch all results to a directoryanchorectl image add ghcr.io/place/thing:v0.1.0 --get all=/path/to/dir
# Submit image for addition to Anchore Enterprise and perform a STIG evaluation locallyanchorectl image add ghcr.io/place/thing:v0.1.0 --stig --stig-profile /path/to/profile --stig-input-file /path/to/inputfile
# Associate the added image with an app version (preferred v6 path; the# --application/-a flag on this command is deprecated and will be removed# in a future release)anchorectl app version asset add container-image-remote ghcr.io/place/thing:v0.1.0 --app myapp --version v3.1.4 --asset thing
Flags
Flag
Type
Environment variable
Default
Required
Description
--annotation
string (repeatable)
ANCHORECTL_IMAGE_ANNOTATION
[]
No
One or more key-value annotations to add on the image in Anchore Enterprise (format: key=value).
-a, --application
string
ANCHORECTL_APPLICATION
""
No
Deprecated. Associate the image with an application at a specific version in the format app@version (example: [email protected]); use anchorectl app version asset add container-image-remote instead.
-d, --dockerfile
string
ANCHORECTL_IMAGE_DOCKERFILE
""
No
Path to the Dockerfile for this image.
-f, --force
bool
ANCHORECTL_FORCE
false
No
Re-analyze the image even if it has already been analyzed.
--from
string
ANCHORECTL_IMAGE_FROM
""
No
Analyze from the given source (default: "", indicating that Anchore Enterprise will pull the image from the registry; allowable-values: <path-to-syft-SBOM>, -, docker, podman, registry, docker-archive) (podman requires a running Podman API service; set CONTAINER_HOST to target a specific or remote socket) (docker and podman: if the image is not present in the daemon it is pulled from the registry).
-g, --get
string (repeatable)
ANCHORECTL_IMAGE_GET
[]
No
Get results and optionally write the raw results to a file (example: content or content=./path/to/file.json or all=/path/to/dir; allowable-keys: image-metadata, sbom, sbomspdx, sbomcyclonedx, content, vulnerability, policy-evaluation, all).
-n, --no-auto-subscribe
bool
ANCHORECTL_IMAGE_NO_AUTO_SUBSCRIBE
false
No
Do not automatically scan newly pushed tags to the registry for the given image.
-p, --platform
string
ANCHORECTL_IMAGE_PLATFORM
""
No
An optional platform specifier for use with --from registry target type (e.g. linux/arm64, linux/arm64/v8, arm64, linux).
--stig
bool
ANCHORECTL_STIG
false
No
Perform a STIG evaluation on the image.
--stig-container-manual-override
string
ANCHORECTL_STIG_CONTAINER_MANUAL_OVERRIDE
""
No
Docker container ID to use as the STIG target (skips creating container with anchore-keep-alive binary).
--stig-input-file
string (repeatable)
ANCHORECTL_STIG_INPUT_FILE
[]
No
Path to input file to use for STIG generation (optional).
--stig-output-dir
string
ANCHORECTL_STIG_OUTPUT_DIR
""
No
Path to save the STIG evaluation (optional).
--stig-profile
string
ANCHORECTL_STIG_PROFILE
""
No
Path to STIG profile (required when --stig is set).
--stig-tools-binary-path
string
ANCHORECTL_STIG_TOOLS_BINARY_PATH
""
No
Path to the statically-linked busybox binary inside the tools image (default: /bin/busybox).
--stig-tools-image
string
ANCHORECTL_STIG_TOOLS_IMAGE
""
No
Container image containing a statically-linked busybox binary for shell-less image support (e.g. docker.io/library/busybox:musl). The binary must be statically linked to work in distroless containers.
--stig-waiver-file
string (repeatable)
ANCHORECTL_STIG_WAIVER_FILE
[]
No
Path to waiver file to use for STIG generation. The waiver file can waive controls and dictate the running and/or reporting of those controls (optional).
-w, --wait
bool
ANCHORECTL_IMAGE_WAIT
false
No
Wait for the analysis to complete.
image ancestors
List analyzed ancestor images, which are the images that form the base layers of the image.
anchorectl image ancestors IMAGE [flags]
Aliases:ancestor
Arguments
Argument
Description
IMAGE
The image to fetch the ancestors for (can be a digest, id, or registry/repo:tag).
Flags
Flag
Type
Environment variable
Default
Required
Description
-b, --base
bool
ANCHORECTL_ANCESTOR_BASE
false
No
Only show the analyzed ancestor image with the fewest layers.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, id. See Output Formats.
-p, --parent
bool
ANCHORECTL_ANCESTOR_PARENT
false
No
Only show the analyzed ancestor image with the most layers.
image check
Get the policy evaluation for the given image.
anchorectl image check IMAGE [flags]
Aliases:evaluate
Arguments
Argument
Description
IMAGE
The image to fetch the policy evaluation for (can be a digest, id or registry/repo:tag). If supplying a digest or image id, a tag must be supplied with the -t flag.
Examples
# Evaluate the active policy against an imageanchorectl image check registry.example.com/my-service:1.4.0
# Show every failing gate, and exit 1 when the evaluation result is failanchorectl image check registry.example.com/my-service:1.4.0 --detail --fail-based-on-results
# Evaluate against a specific policy instead of the active oneanchorectl image check registry.example.com/my-service:1.4.0 --policy strict-policy
Flags
Flag
Type
Environment variable
Default
Required
Description
--base-digest
string
ANCHORECTL_IMAGE_CHECK_BASE_DIGEST
auto
No
Base image digest to compare against so findings report inherited_from_base; auto resolves the base image automatically, empty disables the comparison.
--detail
bool
ANCHORECTL_IMAGE_CHECK_DETAIL
false
No
Show each failed gate within the policy evaluation report.
-f, --fail-based-on-results
bool
ANCHORECTL_FAIL_BASED_ON_RESULTS
false
No
Set the return code to 1 if the policy evaluation result shows as fail.
--history
bool
ANCHORECTL_IMAGE_CHECK_HISTORY
false
No
Show all previous policy evaluations.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results (HTML available with --detail). Allowable values: text, json, json-raw, id, csv, html. See Output Formats.
-d, --output-directory
string
ANCHORECTL_OUTPUT_DIRECTORY
""
No
Optional output directory to write results to.
-p, --policy
string
ANCHORECTL_POLICY
""
No
The policy name or ID to evaluate against (if not provided the default policy is used).
-t, --tag
string
ANCHORECTL_IMAGE_TAG
""
No
Specify which tag (repo:tag) is evaluated for a given image ID or Image digest.
image content
Get image content.
anchorectl image content IMAGE [flags]
Aliases:contents
Arguments
Argument
Description
IMAGE
The image ID, digest, or name:tag to fetch content of.
Flags
Flag
Type
Environment variable
Default
Required
Description
-a, --available-types
bool
ANCHORECTL_AVAILABLE_TYPES
false
No
Only show available content types and exit.
--file
string
ANCHORECTL_FILE
""
No
A file path to write a .tar file containing all retrieved files.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
--overwrite
bool
ANCHORECTL_OVERWRITE
false
No
Write over an existing file when saving retrieved files tarball.
-t, --type
string (repeatable)
ANCHORECTL_CONTENT_TYPES
[]
No
Filter down results to one or more vulnerability types; use --available-types to see valid values (default: fetch all available types).
image delete
Delete an image analysis.
anchorectl image delete IMAGE... [flags]
Aliases:del
Arguments
Argument
Description
IMAGE
One or more images to delete (can be a digest, id or registry/repo:tag). If no tag supplied defaults to latest.
Flags
Flag
Type
Environment variable
Default
Required
Description
-a, --all
bool
—
false
No
Delete all images.
-f, --force
bool
ANCHORECTL_IMAGE_DELETE_FORCE
false
No
Force deletion of image by cancelling any subscription/notification settings prior to image delete.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
image get
Get information about a single image.
anchorectl image get IMAGE [flags]
Arguments
Argument
Description
IMAGE
The image ID, name:tag, name@sha256:digest, name:tag@sha256:digest, or sha256:digest value.
Flags
Flag
Type
Environment variable
Default
Required
Description
-i, --digest
string
ANCHORECTL_IMAGE_DIGEST
""
No
The image digest.
--history
bool
ANCHORECTL_IMAGE_HISTORY
false
No
Show history of images that match the input image.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
image list
List all images visible to the user.
anchorectl image list [flags]
Flags
Flag
Type
Environment variable
Default
Required
Description
-s, --analysis-status
string
ANCHORECTL_IMAGE_ANALYSIS_STATUS
""
No
Filter by analysis_status value on the record. Allowable values: not_analyzed, analyzed, analyzing, analysis_failed.
--history
bool
ANCHORECTL_IMAGE_HISTORY
false
No
Include full history of images (duplicate tags with previous content).
-i, --image
string
ANCHORECTL_IMAGE_NAME
""
No
Tag-based docker-pull string to filter results by (e.g. docker.io/library/nginx:latest, or myhost.com:5000/testimages:v1.1.1).
--image-status
string
ANCHORECTL_IMAGE_STATUS
active
No
Filter by “image_status” value on the record. Allowable values: all, active, deleting.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
image metadata
Get image metadata.
anchorectl image metadata IMAGE [flags]
Arguments
Argument
Description
IMAGE
The image ID, digest, or name:tag to fetch metadata of.
Flags
Flag
Type
Environment variable
Default
Required
Description
--file
string
ANCHORECTL_FILE
""
No
A file path to write the metadata out to.
--overwrite
bool
ANCHORECTL_OVERWRITE
false
No
Write over existing metadata files.
-t, --type
string
ANCHORECTL_METADATA_TYPE
""
No
Filter down results to one or more vulnerability types (run command without this flag to see available types for the given image).
image one-time-scan
Analyze a container image.
anchorectl image one-time-scan IMAGE [flags]
Arguments
Argument
Description
IMAGE
The container image to analyze (e.g. docker.io/library/nginx:latest).
Show policy evaluation details (always enabled for HTML output).
--dockerfile
string
ANCHORECTL_DOCKERFILE
""
No
Path to Dockerfile to use for analysis.
--extended-support
string
ANCHORECTL_EXTENDED_SUPPORT
""
No
Use extended support data (RHEL EUS/ELS, Ubuntu ESM) during the vulnerability scan. Uses the system-configured behavior if not provided. Allowable values: true, false.
--fail-on-policy-error
bool
ANCHORECTL_FAIL_ON_POLICY_ERROR
false
No
Fail if policy evaluation fails.
-o, --format
string
ANCHORECTL_FORMAT
text
No
Output format (text, JSON, json-raw, HTML).
--from
string
ANCHORECTL_FROM
registry
No
Source of the image to analyze (registry, docker, or podman) (docker and podman: if the image is not present in the daemon it is pulled from the registry).
-d, --output-directory
string
ANCHORECTL_OUTPUT_DIRECTORY
""
No
Optional output directory to write results to.
--platform
string
ANCHORECTL_PLATFORM
""
No
Platform to use for analysis.
-p, --policy
string
ANCHORECTL_POLICY
""
No
Policy bundle (name or id) to use for evaluation.
image sbom
Get image SBOM in the native Anchore format.
anchorectl image sbom IMAGE [flags]
Arguments
Argument
Description
IMAGE
The image reference (ID, digest, name:tag).
Flags
Flag
Type
Environment variable
Default
Required
Description
-x, --exclude-files
bool
ANCHORECTL_EXCLUDE_FILES
false
No
Exclude files from the SBOM (this only valid for CycloneDX formats.
-f, --file
string
ANCHORECTL_FILE
""
No
Write the SBOM content to a file (instead of STDOUT).
-o, --output
string
—
syft-json
No
Report output format, options: cyclonedx-json, cyclonedx-xml, purls, spdx-json, spdx-tag-value, syft-json, table, text. See Output Formats.
--overwrite
bool
ANCHORECTL_OVERWRITE
false
No
Write over existing SBOM files.
image vulnerabilities
Get image vulnerabilities.
anchorectl image vulnerabilities IMAGE [flags]
Aliases:vulns, vuln
Arguments
Argument
Description
IMAGE
The image ID, digest, or name:tag to fetch vulnerabilities for.
Examples
# All vulnerabilities for an imageanchorectl image vulnerabilities registry.example.com/my-service:1.4.0
# Only OS package findings the vendor has not marked as won't-fixanchorectl image vulnerabilities registry.example.com/my-service:1.4.0 --type os --vendor-only
# Write JSON results to a directory. --output-directory accepts only# json, json-raw, html, and csvanchorectl image vulnerabilities registry.example.com/my-service:1.4.0 --output json --output-directory ./reports
# CycloneDX output requires an image digest, not a taganchorectl image vulnerabilities sha256:<DIGEST> --output cyclonedx-json
Flags
Flag
Type
Environment variable
Default
Required
Description
--annotations
string (repeatable)
ANCHORECTL_VULNERABILITY_ANNOTATIONS
[]
No
Filter results to include only vulnerabilities with the given annotation status. Accepts a comma separated list of: not_affected, affected, fixed, under_investigation.
-a, --available-types
bool
—
false
No
Only show available vulnerability types and exit.
--include-description
bool
ANCHORECTL_VULNERABILITY_INCLUDE_DESCRIPTION
false
No
Include full descriptions in the vulnerability result.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, csv, cyclonedx-json, cyclonedx-xml, html. See Output Formats.
-d, --output-directory
string
ANCHORECTL_OUTPUT_DIRECTORY
""
No
Optional output directory to write results to.
-r, --refresh
bool
ANCHORECTL_VULNERABILITY_REFRESH
false
No
Refresh the vulnerability match results against the original artifact.
-t, --type
string (repeatable)
ANCHORECTL_VULNERABILITY_TYPE
[]
No
Filter down results to one or more vulnerability types.
--vendor-only
bool
ANCHORECTL_VULNERABILITY_VENDOR_ONLY
false
No
Filter results to include only vulnerabilities that are not marked as invalid by upstream OS vendor data. When set to true, it will filter out all vulnerabilities where will_not_fix is False. If false all vulnerabilities are returned regardless of will_not_fix.
12 - anchorectl inventory
Inventory list operation.
Every command on this page also accepts the global flags.
registry delete — Delete a registry configuration record from the system. Does not remove any images.
registry get — Get information on a specific registry
registry list — List all configured registries the system can/will watch
registry update — Replaces an existing registry record with the given record
registry add
Adds a new registry to the system.
anchorectl registry add REGISTRY [flags]
Arguments
Argument
Description
REGISTRY
Hostname:port string for accessing the registry, as would be used in a docker pull operation. May include some or all of a repository and wildcards (e.g. docker.io/library/* or gcr.io/myproject/myrepository).
Examples
# The password is read from the environment, never passed as a flagANCHORECTL_REGISTRY_PASSWORD=<REGISTRY_PASSWORD> anchorectl registry add registry.example.com \
--username ci-runner
# Verify the credential when the registry is added. If the registry cannot be# reached with these credentials, the command exits 1 and no record is createdANCHORECTL_REGISTRY_PASSWORD=<REGISTRY_PASSWORD> anchorectl registry add registry.example.com \
--username ci-runner --validate
Flags
Flag
Type
Environment variable
Default
Required
Description
--username
string
ANCHORECTL_REGISTRY_USERNAME
""
Yes
Username portion of credential to use for this registry.
--name
string
ANCHORECTL_REGISTRY_NAME
""
No
Human readable name associated with registry record.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
--secure-connection
bool
ANCHORECTL_REGISTRY_SECURE_CONNECTION
true
No
Use TLS/SSL verification for the registry URL.
--type
string
ANCHORECTL_REGISTRY_TYPE
docker_v2
No
Type of registry.
--validate
bool
ANCHORECTL_REGISTRY_VALIDATE
true
No
Whether or not to validate registry/credential at registry add time.
registry delete
Delete a registry configuration record from the system. Does not remove any images.
anchorectl registry delete REGISTRY [flags]
Aliases:del
Arguments
Argument
Description
REGISTRY
The registry name.
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
registry get
Get information on a specific registry.
anchorectl registry get REGISTRY [flags]
Arguments
Argument
Description
REGISTRY
Registry name.
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
registry list
List all configured registries the system can/will watch.
anchorectl registry list [flags]
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
registry update
Replaces an existing registry record with the given record.
anchorectl registry update REGISTRY [flags]
Arguments
Argument
Description
REGISTRY
The registry name.
Flags
Flag
Type
Environment variable
Default
Required
Description
--name
string
ANCHORECTL_REGISTRY_NAME
""
No
Human readable name associated with registry record.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
--secure-connection
bool
ANCHORECTL_REGISTRY_SECURE_CONNECTION
false
No
Use TLS/SSL verification for the registry URL.
--type
string
ANCHORECTL_REGISTRY_TYPE
""
No
Type of registry.
--username
string
ANCHORECTL_REGISTRY_USERNAME
""
No
Username portion of credential to use for this registry.
--validate
bool
ANCHORECTL_REGISTRY_VALIDATE
true
No
Whether or not to validate registry/credential at registry update time.
15 - anchorectl repo
Repository related operations.
Every command on this page also accepts the global flags.
The image ID, name:tag, name@sha256:digest, name:tag@sha256:digest, or sha256:digest value.
STIG_EVALUATION_FILE
The path and filename for the STIG evaluation file.
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
--stig-evaluation-uuid
string
ANCHORECTL_STIG_EVALUATION_UUID
""
No
The UUID for the STIG evaluation to overwrite, if the image already has a STIG evaluation for the same profile this must be provided to upload the new evaluation.
Fully qualified image reference in format [registry/]repository/image:tag@digest.
Flags
Flag
Type
Environment variable
Default
Required
Description
-p, --stig-profile
string
ANCHORECTL_STIG_PROFILE
""
Yes
Path to the Inspec STIG profile, can be a folder containing the extracted profile or an archive e.g. .tar.gz (required).
--platform
string
ANCHORECTL_PLATFORM
""
No
An optional platform specifier used when pulling the image into the docker daemon (e.g. linux/arm64, linux/amd64). Set this when the daemon cannot select an entry from a multi-arch image index on its own (optional).
--stig-container-manual-override
string
ANCHORECTL_STIG_CONTAINER_MANUAL_OVERRIDE
""
No
Docker container ID to use as the STIG target (skips creating container with anchore-keep-alive binary).
-i, --stig-input-file
string (repeatable)
ANCHORECTL_STIG_INPUT_FILE
[]
No
Path to input file to use for STIG generation. The input file can optionally provide variable inputs to the STIG profile that can change the execution of specific controls (optional).
--stig-output-dir
string
ANCHORECTL_STIG_OUTPUT_DIR
""
No
Path to save the STIG evaluation (optional).
--stig-skip-upload
bool
ANCHORECTL_STIG_SKIP_UPLOAD
false
No
Skip uploading the STIG evaluation to Anchore (optional).
--stig-tools-binary-path
string
ANCHORECTL_STIG_TOOLS_BINARY_PATH
""
No
Path to the statically-linked busybox binary inside the tools image (default: /bin/busybox).
--stig-tools-image
string
ANCHORECTL_STIG_TOOLS_IMAGE
""
No
Container image containing a statically-linked busybox binary for shell-less image support (e.g. docker.io/library/busybox:musl). The binary must be statically linked to work in distroless containers.
--stig-waiver-file
string (repeatable)
ANCHORECTL_STIG_WAIVER_FILE
[]
No
Path to waiver file to use for STIG generation. The waiver file can waive controls and dictate the running and/or reporting of those controls (optional).
stig docker image list
List the STIG evaluation metadata for an image.
anchorectl stig docker image list IMAGE [flags]
Arguments
Argument
Description
IMAGE
The image ID, name:tag, name@sha256:digest, name:tag@sha256:digest, or sha256:digest value.
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
stig write-profiles
Write Anchore STIG profiles to disk.
anchorectl stig write-profiles PATH [flags]
Arguments
Argument
Description
PATH
Path to write the profiles to.
17 - anchorectl subscription
Subscription related operations.
Every command on this page also accepts the global flags.
system wait — Wait for configured Anchore system to be running based upon set of filters
system artifact-lifecycle-policy
Global artifact lifecycle policy operations.
anchorectl system artifact-lifecycle-policy [command]
The images and app-versions subcommands manage image rules and Application Version rules respectively. The add,
update, get, list, and delete commands directly under artifact-lifecycle-policy manage image rules only. For
how each rule selects and deletes artifacts, see
Artifact Lifecycle Policies.
Creates an artifact lifecycle policy that deletes application versions which have been EOL for longer than the configured threshold. Deletion is immediate and cannot be undone.
anchorectl system artifact-lifecycle-policy app-versions add [flags]
Flags
Flag
Type
Environment variable
Default
Required
Description
--action
string
—
""
Yes
The artifact policy action. Allowable values: delete.
--days-since-eol
string
—
""
Yes
The number of days a version must have been EOL before it is deleted.
--name
string
—
""
Yes
A unique name for the artifact policy.
--description
string
—
""
No
A description for the policy.
--enable
string
—
false
No
When true, the policy will be enabled. Allowable values: true, false.
-o, --output
string
—
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
system artifact-lifecycle-policy app-versions delete
Delete an application version artifact lifecycle policy.
anchorectl system artifact-lifecycle-policy app-versions delete POLICY_UUID [flags]
Aliases:del
Arguments
Argument
Description
POLICY_UUID
The uuid of the artifact lifecycle policy.
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
system artifact-lifecycle-policy app-versions get
Get a single application version artifact lifecycle policy with its current rule set.
anchorectl system artifact-lifecycle-policy app-versions get POLICY_UUID [flags]
Arguments
Argument
Description
POLICY_UUID
The uuid of the artifact lifecycle policy.
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
system artifact-lifecycle-policy app-versions list
List the artifact lifecycle policies for application versions.
anchorectl system artifact-lifecycle-policy app-versions list [flags]
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
system artifact-lifecycle-policy app-versions update
Updates an application version artifact lifecycle policy. Changing the rule set records a new immutable rule-set version; the previous versions remain readable.
anchorectl system artifact-lifecycle-policy app-versions update POLICY_UUID [flags]
Arguments
Argument
Description
POLICY_UUID
The uuid of the artifact lifecycle policy.
Flags
Flag
Type
Environment variable
Default
Required
Description
--action
string
—
""
Yes
The artifact policy action. Allowable values: delete.
--days-since-eol
string
—
""
Yes
The number of days a version must have been EOL before it is deleted.
--enable
string
—
""
Yes
When true, the policy will be enabled. Allowable values: true, false.
--name
string
—
""
Yes
A unique name for the artifact policy.
--description
string
—
""
No
A description for the policy; pass an empty string to clear it.
-o, --output
string
—
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
system artifact-lifecycle-policy delete
Delete artifact lifecycle policy.
anchorectl system artifact-lifecycle-policy delete POLICY_UUID [flags]
Aliases:del
Arguments
Argument
Description
POLICY_UUID
The uuid of the artifact lifecycle policy.
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
system artifact-lifecycle-policy get
Get single artifact lifecycle policy with latest conditions.
anchorectl system artifact-lifecycle-policy get POLICY_UUID [flags]
Arguments
Argument
Description
POLICY_UUID
The uuid of the artifact lifecycle policy.
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
system artifact-lifecycle-policy images
Image artifact lifecycle policy operations.
anchorectl system artifact-lifecycle-policy images [command]
Creates an artifact lifecycle policy that deletes images not associated with any application version, a configured number of days after their latest analysis. Images associated with an application version are never selected.
anchorectl system artifact-lifecycle-policy images add [flags]
Flags
Flag
Type
Environment variable
Default
Required
Description
--action
string
—
""
Yes
The artifact policy action. Allowable values: delete.
--days-since-analyzed
string
—
""
Yes
The number of days elapsed since the image was analyzed for it to be selected for action.
--even-if-exists-in-runtime
string
—
""
Yes
When true, images matching all criteria and found in the runtime inventory can be selected for action. Allowable values: true, false.
--include-base-images
string
—
""
Yes
When true, images matching all criteria and with known children can be selected for action. Allowable values: true, false.
--include-failed-analysis
string
—
""
Yes
When true, images matching all criteria and in a failed analysis state can be selected for action. Allowable values: true, false.
--name
string
—
""
Yes
A unique name for the artifact policy.
--description
string
—
""
No
A description for the policy.
--enable
string
—
false
No
When true, the policy will be enabled. Allowable values: true, false.
-o, --output
string
—
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
system artifact-lifecycle-policy images delete
Delete an image artifact lifecycle policy.
anchorectl system artifact-lifecycle-policy images delete POLICY_UUID [flags]
Aliases:del
Arguments
Argument
Description
POLICY_UUID
The uuid of the artifact lifecycle policy.
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
system artifact-lifecycle-policy images get
Get a single image artifact lifecycle policy with its current rule set.
anchorectl system artifact-lifecycle-policy images get POLICY_UUID [flags]
Arguments
Argument
Description
POLICY_UUID
The uuid of the artifact lifecycle policy.
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
system artifact-lifecycle-policy images list
List the artifact lifecycle policies for images.
anchorectl system artifact-lifecycle-policy images list [flags]
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
system artifact-lifecycle-policy images update
Updates an image artifact lifecycle policy. Changing the rule set records a new immutable rule-set version; the previous versions remain readable.
anchorectl system artifact-lifecycle-policy images update POLICY_UUID [flags]
Arguments
Argument
Description
POLICY_UUID
The uuid of the artifact lifecycle policy.
Flags
Flag
Type
Environment variable
Default
Required
Description
--action
string
—
""
Yes
The artifact policy action. Allowable values: delete.
--days-since-analyzed
string
—
""
Yes
The number of days elapsed since the image was analyzed for it to be selected for action.
--enable
string
—
""
Yes
When true, the policy will be enabled. Allowable values: true, false.
--even-if-exists-in-runtime
string
—
""
Yes
When true, images matching all criteria and found in the runtime inventory can be selected for action. Allowable values: true, false.
--include-base-images
string
—
""
Yes
When true, images matching all criteria and with known children can be selected for action. Allowable values: true, false.
--include-failed-analysis
string
—
""
Yes
When true, images matching all criteria and in a failed analysis state can be selected for action. Allowable values: true, false.
--name
string
—
""
Yes
A unique name for the artifact policy.
--description
string
—
""
No
A description for the policy; pass an empty string to clear it.
-o, --output
string
—
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
system artifact-lifecycle-policy list
List all artifact lifecycle policies.
anchorectl system artifact-lifecycle-policy list [flags]
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
system artifact-lifecycle-policy update
Updates an artifact lifecycle policy.
anchorectl system artifact-lifecycle-policy update POLICY_UUID [flags]
Flags
Flag
Type
Environment variable
Default
Required
Description
--action
string
—
""
Yes
The artifact policy action. Allowable values: delete.
--artifact-type
string
—
""
Yes
The artifact type the policy will act on. Allowable values: image.
--days-since-analyzed
string
—
""
Yes
The number of days elapsed since the artifact was analyzed for it to be selected for action.
--enable
string
—
""
Yes
When true, the policy will be enabled. Allowable values: true, false.
--even-if-exists-in-runtime
string
—
""
Yes
When true, images matching all criteria and found in the runtime inventory can be selected for action. Allowable values: true, false.
--include-base-images
string
—
""
Yes
When true, images matching all criteria and with known children can be selected for action. Allowable values: true, false.
--include-failed-analysis
string
—
""
Yes
When true, images matching all criteria and in a failed analysis state can be selected for action. Allowable values: true, false.
--name
string
—
""
Yes
A unique name for the artifact policy.
--description
string
—
""
No
A description for the policy.
-o, --output
string
—
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
system delete
Delete service.
anchorectl system delete SERVICE_NAME HOST_ID [flags]
Aliases:del
Arguments
Argument
Description
SERVICE_NAME
The service to delete, as shown in the SERVICE column of anchorectl system status.
HOST_ID
The host ID of the service instance, as shown in the HOST ID column of anchorectl system status.
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
Path to a JSON input file or - to read from stdin.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
-u, --user
string (repeatable)
ANCHORECTL_USER
[]
No
The username(s) that will be associated with the User Group.
usergroup user delete
Remove user(s) from this user group.
anchorectl usergroup user delete USER_GROUP [flags]
Aliases:del
Arguments
Argument
Description
USER_GROUP
The name or uuid of the user group.
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
-u, --user
string (repeatable)
ANCHORECTL_USER
[]
No
The username(s) that will be removed from the User group.
usergroup user list
List users configured in this user group.
anchorectl usergroup user list USER_GROUP [flags]
Arguments
Argument
Description
USER_GROUP
The name or uuid of the user group.
Flags
Flag
Type
Environment variable
Default
Required
Description
-i, --input
string
ANCHORECTL_INPUT
""
No
Path to a JSON input file or - to read from stdin.
-o, --output
string
ANCHORECTL_FORMAT
text
No
The format to show the results. Allowable values: text, json, json-raw, id. See Output Formats.
21 - anchorectl version
Show anchorectl version information.
Every command on this page also accepts the global flags.
anchorectl version [flags]
Examples
# Print just the version string; works only as a root flaganchorectl --version
# Full build detail: Syft version, build date, commit, and platformanchorectl version
# Machine-readable. ANCHORECTL_FORMAT is ignored here, so pass the flag explicitlyanchorectl version --output json
Flags
Flag
Type
Environment variable
Default
Required
Description
-o, --output
string
—
text
No
The format to show the results. Allowable values: text, json. See Output Formats.