Skip to main content

perpetual pack

Browse and manage content packs.

perpetual pack diff​

Show what updating an installation to its pack's latest release would change.

perpetual pack diff <installation>

Changes: Leaves no lasting change. Stages the update into a temporary changeset it always deletes, also on Ctrl-C. If the server stages the update into another changeset instead, pack diff reports it and leaves it there.

Output: With --json, prints its result in the JSON envelope and any error in the error envelope.

Arguments​

ArgumentRequiredDescription
installationRequiredInstallation ID (PKI_*).

Also accepts the global flags, including the sign-in flags.

perpetual pack get​

Get a content pack.

perpetual pack get <pack>

Changes: Stages nothing.

Output: With --json, prints its result in the JSON envelope and any error in the error envelope.

Arguments​

ArgumentRequiredDescription
packRequiredContent pack ID (PAK_*).

Also accepts the global flags, including the sign-in flags.

perpetual pack init​

Start a new org content pack directory with its pack.yaml.

perpetual pack init <dir> [flags]

Changes: Stages nothing.

Output: With --json, prints its result in the JSON envelope and any error in the error envelope.

Arguments​

ArgumentRequiredDescription
dirRequiredDirectory for the new pack.

Flags​

FlagTypeRequiredDescription
--namestringOptionalThe pack's name.
--descriptionstringOptionalWhat the pack is for (default: empty).

Also accepts the global flags.

perpetual pack install​

Install a content pack: commit the install in one run after confirming, or stage it into --changeset.

perpetual pack install <pack> [flags]

Changes: Stages its writes into a changeset.

Output: With --json, prints its result in the JSON envelope and any error in the error envelope.

Arguments​

ArgumentRequiredDescription
packRequiredContent pack ID (PAK_*).

Flags​

FlagTypeRequiredDescription
--spacestring, repeatableOptionalSpaces to install into: SPC_* ids, comma-separated or repeated.
--link-modestringOptionalManual, Automatic or Copy (server default when omitted).
--install-pathstringOptionalFolder path to install under.
--install-deployedbooleanOptionalDeploy the pack's detections, lookups and integrations now; later updates deploy the detections and lookups they add.
--bindstring, repeatableOptionalParser to connector bindings PRS_*=CON_*, comma-separated or repeated; each connector must be in a --space.
--changesetstringOptionalStage into this draft changeset (CHG_*) instead of committing in one run.
--forcebooleanOptionalSkip the commit prompt when committing in one run (required without a terminal).
--namestringOptionalName the changeset (with --changeset, renames it; must not be empty); Simba may rename it if the name stops describing its changes.
--descriptionstringOptionalDescribe the changeset (with --changeset, replaces its description; must not be empty).

Also accepts the global flags, including the sign-in flags.

perpetual pack install-deployed​

Set whether future updates deploy newly added detections and lookups.

perpetual pack install-deployed <installation> <value>

Changes: Writes live, outside any changeset. The installation's deploy default for future updates cannot be staged; the API applies it immediately.

Output: With --json, prints its result in the JSON envelope and any error in the error envelope.

Arguments​

ArgumentRequiredDescription
installationRequiredInstallation ID (PKI_*).
valueRequiredTrue or false.

Also accepts the global flags, including the sign-in flags.

perpetual pack installations​

List pack installations.

perpetual pack installations [flags]

Changes: Stages nothing.

Output: With --json, prints its result in the JSON envelope and any error in the error envelope.

Flags​

FlagTypeRequiredDescription
--spacestring, repeatableOptionalOnly these spaces: SPC_* ids, comma-separated or repeated.
--packstringOptionalOnly this content pack (PAK_*).

Also accepts the global flags, including the sign-in flags.

Change an installation's link mode, in one run or into --changeset.

perpetual pack link-mode <installation> <mode> [flags]

Changes: Stages its writes into a changeset.

Output: With --json, prints its result in the JSON envelope and any error in the error envelope.

Arguments​

ArgumentRequiredDescription
installationRequiredInstallation ID (PKI_*).
modeRequiredManual or Automatic.

Flags​

FlagTypeRequiredDescription
--changesetstringOptionalStage into this draft changeset (CHG_*) instead of committing in one run.
--forcebooleanOptionalSkip the commit prompt when committing in one run (required without a terminal).
--namestringOptionalName the changeset (with --changeset, renames it; must not be empty); Simba may rename it if the name stops describing its changes.
--descriptionstringOptionalDescribe the changeset (with --changeset, replaces its description; must not be empty).

Also accepts the global flags, including the sign-in flags.

perpetual pack list​

List content packs.

perpetual pack list [flags]

Changes: Stages nothing.

Output: With --json, prints its result in the JSON envelope and any error in the error envelope.

Flags​

FlagTypeRequiredDescription
--perpetual-suppliedbooleanOptionalOnly packs supplied by Perpetual.

Also accepts the global flags, including the sign-in flags.

perpetual pack pull​

Write an org content pack and its templates as a pack directory, editing an existing one in place.

perpetual pack pull <pack> [flags]

Changes: Stages nothing.

Output: With --json, prints its result in the JSON envelope and any error in the error envelope.

Arguments​

ArgumentRequiredDescription
packRequiredContent pack ID (PAK_*).

Flags​

FlagTypeRequiredDescription
--dirstringOptionalGitOps root (default .).
--outstringOptionalDirectory for a pack new to the repository (default packs/<pack name>).

Also accepts the global flags, including the sign-in flags.

perpetual pack status​

Show whether pack installations are behind their pack.

perpetual pack status [installation] [flags]

Changes: Stages nothing.

Output: With --json, prints its result in the JSON envelope and any error in the error envelope.

Arguments​

ArgumentRequiredDescription
installationOptionalInstallation ID (PKI_*); omit to report every installation.

Flags​

FlagTypeRequiredDescription
--spacestring, repeatableOptionalOnly these spaces: SPC_* ids, comma-separated or repeated.
--dirstringOptionalGitOps root whose override files to list per installation; without it no files are read.

Also accepts the global flags, including the sign-in flags.

perpetual pack uninstall​

Remove pack installations, in one run or into --changeset.

perpetual pack uninstall [installations] [flags]

Changes: Stages its writes into a changeset.

Output: With --json, prints its result in the JSON envelope and any error in the error envelope.

Arguments​

ArgumentRequiredDescription
installationsOptionalInstallation IDs (PKI_*).

Flags​

FlagTypeRequiredDescription
--changesetstringOptionalStage into this draft changeset (CHG_*) instead of committing in one run.
--forcebooleanOptionalSkip the commit prompt when committing in one run (required without a terminal).
--namestringOptionalName the changeset (with --changeset, renames it; must not be empty); Simba may rename it if the name stops describing its changes.
--descriptionstringOptionalDescribe the changeset (with --changeset, replaces its description; must not be empty).

Also accepts the global flags, including the sign-in flags.

perpetual pack update​

Update pack installations to their pack's latest release, in one run or into --changeset.

perpetual pack update [installations] [flags]

Changes: Stages its writes into a changeset.

Output: With --json, prints its result in the JSON envelope and any error in the error envelope.

Arguments​

ArgumentRequiredDescription
installationsOptionalInstallation IDs (PKI_*).

Flags​

FlagTypeRequiredDescription
--allbooleanOptionalUpdate every live installation that is behind its pack.
--spacestring, repeatableOptionalWith --all: only these spaces, SPC_* ids comma-separated or repeated.
--changesetstringOptionalStage into this draft changeset (CHG_*) instead of committing in one run.
--forcebooleanOptionalSkip the commit prompt when committing in one run (required without a terminal).
--namestringOptionalName the changeset (with --changeset, renames it; must not be empty); Simba may rename it if the name stops describing its changes.
--descriptionstringOptionalDescribe the changeset (with --changeset, replaces its description; must not be empty).

Also accepts the global flags, including the sign-in flags.


Perpetual CLI 0.5.0