Instacli Command Reference

Overview of standard commands in Instacli.

REST API interaction

Http client

GET - Sends a GET request to an HTTP endpoint
POST - Sends a POST request to an HTTP endpoint
PUT - Sends a PUT request to an HTTP endpoint
PATCH - Sends a PATCH request to an HTTP endpoint
DELETE - Sends a DELETE request to an HTTP endpoint
Http request defaults - Sets the default parameters for all subsequent HTTP commands.

Manage credentials

Connect to - Sets up a connection to a named endpoint
Create credentials - Configures a credentials for an endpoint and saves it in the user's preferences.
Get credentials - Gets the default credentials for an endpoint
Get all credentials - Gets all credential for an endpoint
Set default credentials - Sets the default credentials for an endpoint
Delete credentials - Deletes credentials for an endpoint

Http server

Http server - Starts an embedded HTTP server, based on an OpenAPI-flavored spec and backed by Instacli scripts

Core instacli

Script definition

Script info - Contains script description and input parameter definitions.

Variables

${..} assignment - Sets a variable value
As - Sets a variable to the contents of the output variable
Output - Sets the output variable

Testing

Test case - Marks a test case
Assert that - Executes a condition
Assert equals - Tests two objects for equality
Code example - Marks example code
Expected output - Tests the output variable against a given value
Expected error - Tests if an error was raised
Stock answers - Prerecords answers for prompts, so they can pass automated tests.

Control flow

Do - Executes one or more commands
Exit - Stops running the current script
For each - Loops over or transforms a list or object
Repeat - Executes a block of code until a condition is satisfied
If - exectues commands if a condition holds
When - Executes a single command from a list of conditions

Error handling

Error - Raises an error
On error - Handles any error
On error type - Handles an error of a specific type

User interaction

Prompt - Asks the user for input with an interactive prompt
Prompt object - Asks mutlitple questions and stores the answers into one object

Data manipulation

Add - Adds items
Add to - Adds items to existing variables
Append - Adds items to the output variable
Find - Retrieves a snippet from a larger object
Replace - Does a text-based find&replace
Size - Gives you the size of things
Sort - Sorts an array

Files

Read file - Loads Yaml or Json from a file
Save as - Saves content to a file as Yaml
Run script - Runs another Instacli script
Instacli files as commands - To run any instacli file in the same directory as a regular command

Shell

Shell - Executes a shell command

Util

Print - Prints to the console
Wait - Waits a while
Base64 encode - Does a Base64 encoding
Base64 decode - Decodes a Base64 encoded text