sked artifacts custom-agent

Manage the retrieval and deployment of Tempo custom agents.

Overview

Manage the retrieval and deployment of Tempo custom agents. A custom agent is an agent profile: a named specification that gives Tempo instructions and a tool allowlist specific to your operation. For the state file format and how a deployed agent is used, see Custom agents.

$ sked artifact custom-agent <command>

Deploying a custom agent saves the specification as a draft and publishes it in one step. The artifact always represents the published version: get and list return published agents only, and delete archives the agent so that Tempo stops routing to it.

If the custom-agent commands are missing from your CLI, run sked artifacts update-descriptors to refresh the list of artifact types. If they are still missing, contact Skedulo support.

Commands

Command Description
Create Create a custom agent from a state file [deprecated, use upsert instead]
Delete Delete a custom agent
Get Get the state file for a custom agent
List List the existing custom agents
Update Update a custom agent from a state file [deprecated, use upsert instead]
Upsert Create or Update a custom agent from a state file

Create

Description

Create a custom agent from a state file [deprecated, use upsert instead]

Usage

  $ sked artifacts custom-agent create -f <value> [--json] [-a <value>] [-w <value>] [--name <value>]

Flags

Flag Description Required
-f, --filename= The state file. Yes
-a, --alias=<value> The alias to use to authenticate. No
-w, --wait=<value> [default: 900] Number of seconds to wait for the command to complete and display results to the terminal window. No
--name=<value> The name of the custom agent. No

Global flags

Flag Description Required
--json Format output as json. No

Delete

Description

Delete a custom agent. The agent is archived: Tempo stops routing to it immediately, and its version history is kept.

Usage

  $ sked artifacts custom-agent delete --name <value> [--json] [-a <value>] [-w <value>]

Flags

Flag Description Required
--name=<value> The name of the custom agent. Yes
-a, --alias=<value> The alias to use to authenticate. No
-w, --wait=<value> [default: 900] Number of seconds to wait for the command to complete and display results to the terminal window. No

Global flags

Flag Description Required
--json Format output as json. No

Get

Description

Get the state file for a custom agent. Returns the published version; an agent that only has a draft is reported as not found.

Usage

  $ sked artifacts custom-agent get --name <value> [--json] [-o <value>] [-a <value>]

Flags

Flag Description Required
--name The name of the custom agent. Yes
-a, --alias The alias to use to authenticate. No
-o, --outputdir The output directory. No

Global flags

Flag Description Required
--json Format output as json. No

List

Description

List the existing custom agents. Only published agents are listed.

Usage

  $ sked artifacts custom-agent list [--json] [-a <value>]

Flags

Flag Description Required
-a, --alias=<value> The alias to use to authenticate. No

Global flags

Flag Description Required
--json Format output as json. No

Update

Description

Update a custom agent from a state file [deprecated, use upsert instead].

Usage

  $ sked artifacts custom-agent update -f <value> [--json] [-a <value>] [-w <value>] [--name <value>]

Flags

Flag Description Required
-f, --filename=<value> The state file. Yes
-a, --alias=<value> The alias to use to authenticate. No
-w, --wait=<value> [default: 900] Number of seconds to wait for the command to complete and display results to the terminal window. No
--name=<value> The name of the custom agent. No

Global flags

Flag Description Required
--json Format output as json. No

Upsert

Description

Create or Update a custom agent from a state file. The agent is validated and published as part of the deploy; a blocking validation finding fails the command and reports the findings.

Usage

  $ sked artifacts custom-agent upsert -f <value> [--json] [-a <value>] [-w <value>] [--name <value>]

Flags

Flag Description Required
-f, --filename=<value> The state file. Yes
-a, --alias=<value> The alias to use to authenticate. No
-w, --wait=<value> [default: 900] Number of seconds to wait for the command to complete and display results to the terminal window. No
--name=<value> The name of the custom agent. No

Global flags

Flag Description Required
--json Format output as json. No

See also

  • Custom agents: the state file format, validation rules, and how Tempo uses a published agent.
  • Work with packages: custom agents deploy last in a package, after the configuration variables they reference.