• Beta
Bash SDK
  • Updated on 10 Jul 2020
  • 1 minute to read
  • Share
  • Dark
    Light

Bash SDK

  • Share
  • Dark
    Light

Bash

Supported methods

The following SDK methods are supported by the Bash SDK:

  • Secret
  • Config
  • Track

Secret

Access the current team's secret store.

Subcommands:

Get:

USAGE:

sdk secret get <KEY>

OPTIONS:

-H, --hidden    If provided, suppresses the user notification that the secret has been retrieved

ARGS:

<KEY>    The key of the desired secret in the secret store

Set:

USAGE:

sdk secret set --key <KEY> --value <VALUE>

OPTIONS:

-k, --key <KEY>        The key to set the secret under in the secret store
-v, --value <VALUE>    The value to set in the secret store

Example:

sdk secret set --key='secret1' --value='shh'secret=$(sdk secret get secret1)
echo $secret

Output:

shh

Config

Access the current team's configuration store.

Subcommands:

Get:

USAGE:

sdk config get <KEY>

or

sdk config get --all

ARGS:

<KEY>    The key of the desired value in the configuration store

Set:

USAGE:

sdk config set --key <KEY> --value <VALUE>

OPTIONS:

-k, --key <KEY>        The key to set the value under in the configuration store
-v, --value <VALUE>    The value to set in the configuration store

Delete:

USAGE:

sdk config delete <KEY>

ARGS:

<KEY>    The key of the desired value to be deleted from the configuration store

Example:

cto-ai config set --key='myop_target_domain' --value='cto.ai'

domain=$(cto-ai config get myop_target_domain)
echo $domain

wasDeleted=$(sdk config delete myop_target_domain)
if $wasDeleted; then echo "myop_target_domain was successfully deleted"; fi

Output:

cto.ai
myop_target_domain was successfully deleted

Track

Track a workflow event.

USAGE:

sdk track [OPTIONS] <EVENT> [PARAM]...

OPTIONS:

-e, --error <ERROR>    An error string to report

ARGS:

<EVENT>       The event name to track
<PARAM>...    Parameters for the tracking event. Takes key:value metadata entries or tags as strings without colons

Example:

sdk track deploy production image:jifejfdkdkdi3930 

Result:

Sends an analytics event to The Ops Platform with event deploy, tag production, and metadata {image: jifejfdkdkdi3930}.

Events

Retrieve events that were sent with sdk.track.

USAGE:

sdk events STARTTIME [ENDTIME]

Timestamps can be given in ISO format.

Example:

sdk events -s "2020-05-12T20:47:45Z" -e "2020-06-12T20:47:45Z" 

Result:

Retrieves a list of events from The Ops Platform that were stored for the active team that occurred between the two given times.

🚀 What's next?

  • To learn more about the UX options available for you, please go to Bash UX page.
  • To see which prompts we offer for this SDK, you can go to Bash Prompts page.
Was this article helpful?