https://github.com/mlafeldt/ck
The ConvertKit Tool
https://github.com/mlafeldt/ck
automation convertkit email-marketing golang
Last synced: 2 months ago
JSON representation
The ConvertKit Tool
- Host: GitHub
- URL: https://github.com/mlafeldt/ck
- Owner: mlafeldt
- License: mpl-2.0
- Created: 2017-07-20T09:42:32.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-02-20T21:02:32.000Z (over 6 years ago)
- Last Synced: 2025-03-16T10:24:19.199Z (3 months ago)
- Topics: automation, convertkit, email-marketing, golang
- Language: Go
- Homepage:
- Size: 48.8 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# ck - The ConvertKit Tool
[](https://travis-ci.org/mlafeldt/ck)
[](https://godoc.org/github.com/mlafeldt/ck/convertkit)
Access the [ConvertKit API](http://help.convertkit.com/article/33-api-documentation-v3) from the command line.
## Installation
If you're on Mac OS X, the easiest way to get the `ck` command-line tool is via Homebrew:
```bash
brew tap mlafeldt/formulas
brew install cktool
```
You can also build the tool from source, provided you have Go installed:
```bash
go get -u github.com/mlafeldt/ck
```
## Usage
```
Usage:
ck [command]
Available Commands:
help Help about any command
subscribers List subscribers
version Show program version
Flags:
--api-endpoint string Set ConvertKit API endpoint
--api-key string Set API key for ConvertKit account
--api-secret string Set API secret for ConvertKit account
-h, --help help for ck
Use "ck [command] --help" for more information about a command.
```
The tool understands these environment variables:
* `CONVERTKIT_API_KEY` - the same as `--api-key`
* `CONVERTKIT_API_SECRET` - the same as `--api-secret`
* `CONVERTKIT_API_ENDPOINT` - the same as `--api-endpoint`
## Go library
In addition to the CLI tool, the project also provides the `convertkit` Go library for use in other Go projects. To install it from source:
```bash
go get -u github.com/mlafeldt/ck/convertkit
```
For usage and examples, see the [Godoc documentation](https://godoc.org/github.com/mlafeldt/ck/convertkit).
## Author
This project is being developed by [Mathias Lafeldt](https://twitter.com/mlafeldt).