ZL
About Articles Contact
Published on Apr 1, 2020
Filed under:
#convertkit

A Simple CLI for Convertkit

When I need to check a person’s details on Convertkit, I need to log in to Convertkit and search for the person’s email address. This process takes time, energy, and clicks.

I’m not in the state to check a website when I’m doing work. I want to find the person’s information quickly and get stuff done.

So I created a command line interface for Convertkit.

Note: Links to Convertkit in this article are affiliate links. Feel free to use them if you want to support me a little bit :)

The Convertkit CLI

The Convertkit CLI lets you do four things:

  1. Get information about a subscriber
  2. List tags
  3. Add a tag to a subscriber
  4. Remove a tag from a subscriber

Installing the CLI

You can install the CLI with npm:

Terminal window
npm install convertkit-cli -g

This lets you use the ck command.

Logging in

You need to provide your API Secret for the Convertkit CLI to work. You can find the API Secret on your accounts settings page.

Your API Secret is kept safe in your computer, so don’t worry about it leaking out :)

You use the login command to provide the API Secret.

Terminal window
ck login <API_SECRET>

Getting information about a subscriber

You can use the subscriber command to get information about a subscriber.

Terminal window
ck subscriber <email>

This returns the following information:

  1. Name
  2. Email address
  3. State
  4. Date created
  5. Tags
Gets a subscriber.

Listing Tags

You can use the tags command to list tags.

Terminal window
ck tags
Gets list of tags.

Tagging a subscriber

You can use the tagsub command to tag a subscriber. The tagsub command contains two subcommands.

  • add: Adds a tag to a subscriber
  • remove: Removes a tag from a subscriber

To tag a subscriber, you use tagsub add.

Terminal window
ck tagsub add <tag> <email>
Adds tag to subscriber

Removing a tag from a subscriber

To remove a tag from a subscriber, you use tagsub remove.

Terminal window
ck tagsub remove <tag> <email>
Removes tag from a subscriber

Contributions welcome!

This CLI is in an early stage draft. It’s not perfect yet. But I want to push this out so people (other than myself) can use it.

Here’s the Github repository if you want to contribute some code :)

Previous First look at Snowpack Next How I work with arrays

Join My Newsletter

I share what I’m learning on this newsletter: code, building businesses, and living well.

Sometimes I write about technical deep-dives, product updates, musings on how to live, and sometimes my struggles and how I’m breaking through.

Regardless of the type of content, I do my best to send you an update every week.

If you’re into making things and growing as a person, you’ll probably feel at home here.

“

Zell is the rare sort of developer who both knows his stuff and can explain even the most technical jargon in approachable — and even fun — ways!

I’ve taken his courses and always look forward to his writing because I know I’ll walk away with something that makes me a better front-ender.

Geoff Graham
Geoff Graham — Chief Editor @ CSS Tricks
The Footer

General

Home About Contact Testimonials Tools I Use

Projects

Magical Dev School Splendid Labz

Socials

Youtube Instagram Tiktok Github Bluesky X

Follow Along

Email RSS
© 2013 - 2025 Zell Liew / All rights reserved / Terms