Skip to main content

Skrybe CLI

@skrybe/cli is the command line interface for the Skrybe email marketing API. It installs a single command, skrybe, that manages lists, subscribers, campaigns, templates and autoresponders, and sends email, from a terminal or a script.

npm install -g @skrybe/cli
skrybe auth login
# API key: (paste it here)

skrybe lists
ID                      NAME
l7763lkC1Ld892Ty4p3pvxw Newsletter
3t8NqP0wKqv7X1v892bVZQ Customers

How it is organised​

Commands are grouped by resource: skrybe lists, skrybe subscribers, skrybe campaigns and so on. A bare resource name shows the collection, so the common case needs no verb:

skrybe campaigns                 # newest first
skrybe campaigns get 42 # one campaign
skrybe campaigns stats 42 # its opens, clicks and bounces

ls (or list) also works as an explicit verb wherever a group has a collection to show, for example skrybe lists ls.

What it is for​

  • People at a terminal. Tables by default, confirmation before anything that sends or deletes.
  • Scripts and CI. --output json or --output text, errors in the same shape, stable exit codes, and credentials from environment variables so no config file is needed.

Next steps​

The CLI talks to the same HTTP API that is documented in the Skrybe API docs. Each command page here names the endpoint it calls.