@cord-sdk/cli

cord-sdk ·

A CLI tool to make it easy to interact with our REST API for manual exploration or automated changes.

Install

1. install the package from npm:

npm i -g @cord-sdk/cli

1. Initialize Cord:

Run

cord init

This command will ask you for some credentials and add them to a .cord file within your home directory. To run any command (other than cord project) you will need the CORD_PROJECT_ID and CORD_PROJECT_SECRET of the project you would like to query within. These values can be found in the console under your chosen project's entry.

The CORD_CUSTOMER_ID and CORD_CUSTOMER_SECRET are only needed if you need app management commands, which you probably don't. If you do, they can be found in the console, under View application management credentials.

If you already have a .cord file and would like to re-configure your variables, running cord init will default to the existing values.

1. Start commanding!

Try out:

cord --help

to see what you can do!

Usage & Documentation

Now that you have everything set up, you're good to go! Every REST endpoint has a corresponding command in the CLI tool.

You can run --help on any command to see what arguments it takes.

If you prefer to use cURL syntax but would like to benefit from our automatic authentication, then you can use cord curl project -- <request> for project management commands, and cord curl -- <request> for all others.

To see more information on how to interact with an endpoint, see our docs which contains detailed descriptions of every argument and return value.