⛏️ Tools
Who and what is the CLI tool for?

Who and what is the CLI tool for?

Validated on 8 April 2022 • Posted on 8 April 2022
 
The Octy CLI is a developer tool to help you manage your integration with Octy directly from your terminal. It’s simple to install and works on macOS, Windows, and Linux. With the Octy CLI you can:
  • Update your account configurations
  • Update Octy algorithm configurations
  • Create any of the following raw data resources: profiles, items, event instances
  • Create, retrieve, update*, or delete any of the following Octy object definition resources: event types, segments, message templates *updates can only be applied to message templates
  • Generate a churn prediction analysis report
 
We created the CLI tool to be used by both software engineers and tech-savvy people within your organisation to manage configurations, data and Octy object resources with ease. Some commands are more complex than others, but that doesn’t mean only engineers can make use of the CLI tool.
For example, if you needed to generate a churn prediction analysis report (a list of the top customer attributes that contribute to churn) and didn’t want to bother an engineer, it's as simple as following these steps (on a device that has the Octy CLI tool installed and has already been configured to authenticate with Octy’s servers):
 
  1. On a Mac press Command + Space to open Spotlight search. Once open, type the word “Terminal”
notion image
  1. After opening the terminal app, copy and paste or type the following command.
./octy-cli get churnreport -o ~/Desktop
This command will generate a churn prediction analysis report that will be saved in a markdown file on your Desktop (a file with the extension .md). You can then open this file in any web browser and share it with the relevant department or individual. Simple.
 

Related Topics

—