klev-cli

A cli to interact with klev

Authentication

To interact with klev you need an authtoken. You can get one after registering at the dashboard. Pass it to the cli either via --authtoken flag or through KLEV_TOKEN environment variable. For example:

$ klev --authtoken "XXX_YYY" paths
{
  "/egress_webhook": "get/delete egress webhook",
  "/egress_webhooks": "list/create egress webhooks",
  "/ingress_webhook": "get/delete ingress webhook",
  "/ingress_webhooks": "list/create ingress webhooks",
  "/log": "get/delete log",
  "/logs": "list/create logs",
  "/message": "post/get message",
  "/messages": "publish/consume messages",
  "/offset": "get/set/delete offset",
  "/offsets": "list offsets",
  "/token": "get/delete token",
  "/tokens": "list/create tokens"
}

Basic usage

klev gives access to most of the functionality available through the api.

$ klev 
cli to interact with klev

Usage:
  klev [command]

Available Commands:
  completion       Generate the autocompletion script for the specified shell
  consume          consumes messages
  egress-webhooks  interact with egress webhooks
  help             Help about any command
  ingress-webhooks interact with ingress webhooks
  logs             interact with logs
  offsets          interact with offsets
  paths            get paths in klev; validate token
  publish          publish a message
  tokens           interact with tokens

Flags:
      --authtoken string   token to use for authorization
  -h, --help               help for klev

Use "klev [command] --help" for more information about a command.

Publishing messages

To publish a message with values as a string use:

$ klev publish log_2IKrqtEBeYobBAM2gkuFNB6pBFL --value "hello world"
{
  "next_offset": 1
}

Consuming messages

To consume messages and render them as strings use:

$ klev consume log_2IKrqtEBeYobBAM2gkuFNB6pBFL --encoding string
{
  "next_offset": 1,
  "encoding": "string",
  "messages": [
    {
      "offset": 0,
      "time": 0,
      "value": "hello world"
    }
  ]
}

Releasing

To release a new version of the cli:

• run make release
• use GH UI to create a new release, attaching everything from dist/archive/