- Updated On 21 Jan 2021
- 2 Minutes To Read
The following SDK methods are supported by the Bash SDK:
Starts a remote command/pipeline/service that belongs to the same team as the pipelines, service, or command that executes the method.
sdk.start(workflowName: string): void
sdk start <workflow name>
Access the current team's secret store.
sdk secret get <KEY>
-H, --hidden If provided, suppresses the user notification that the secret has been retrieved
<KEY> The key of the desired secret in the secret store
sdk secret set --key <KEY> --value <VALUE>
-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
sdk secret set --key='secret1' --value='shh'secret=$(sdk secret get secret1) echo $secret
Access the current team's configuration store.
sdk config get <KEY>
sdk config get --all
<KEY> The key of the desired value in the configuration store
sdk config set --key <KEY> --value <VALUE>
-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
sdk config delete <KEY>
<KEY> The key of the desired value to be deleted from the configuration store
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
cto.ai myop_target_domain was successfully deleted
The track function allows you to send Events and retrieve custom analytic data.
sdk track [OPTIONS] <EVENT> [PARAM]...
-e, --error <ERROR> An error string to report
<EVENT> The event name to track <PARAM>... Parameters for the tracking event. Takes key:value metadata entries or tags as strings without colons
sdk track deploy image:jifejfdkdkdi3930
Sends an analytics event to The Ops Platform with event
deploy and metadata
Using Track to Create Events for Insights
Tracking Workflow Metrics using CTO.ai can give deep insight into your team's activity. To use track to send a Workflow Metric event, place your event data in the
<PARAM> field like so:
#!/bin/bash sdk track "" \ event_name:deployment \ event_action:succeeded \ repo:web \ commit:956b425e5bee \ branch:main
"" argument (the first argument) is a metadata field that isn't used by the metrics dashboard, but is required by the
sdk.track function, so it has been left blank in this example.
More information about Insights and Wokflow Agents can be found on the Insights Overview page.
Retrieve events that were sent with
sdk events STARTTIME [ENDTIME]
Timestamps can be given in ISO format.
sdk events -s "2020-05-12T20:47:45Z" -e "2020-06-12T20:47:45Z"
Retrieves a list of events from CTO.ai that were stored for the active team that occurred between the two given times.