/nats-cli

NATS client CLI

Primary LanguageGo

nats-cli Build Status

NATS client CLI

Similar projects:

Installation

Download the binary from one of the releases (in example below, amd64 is the output of dpkg --print-architecture)

wget https://github.com/shadiakiki1986/nats-cli/releases/download/0.0.4.2/nats-amd64 -O /sbin/nats
chmod +x /sbin/nats

Now you can run it with: nats ...

Usage

  1. Publish to channel "foo" the message "help me!"

    nats pub foo "help me!"

  2. Do the same on a different server

    nats --server nats://someserver:4222 pub foo "help me!"

  3. Subscribe to channel "foo" and just display the messages received in the console

    nats sub foo

  4. Subscribe to channel "foo" and trigger a command upon receipt of the automatically generated token (check token in command output line Message should match with token: ...)

    nats sub --cmd 'echo "hey"' foo

    Output

    2017/02/03 10:33:19 Start
2017/02/03 10:33:19 Connected to server:  nats://localhost:4222
2017/02/03 10:33:19 Listening for messages on: foo
2017/02/03 10:33:19 Message should match with token: 022d59bdf309dc22
2017/02/03 10:33:25 Received a message: 022d59bdf309dc22
2017/02/03 10:33:25 Messag matches with token .. triggering command: 'echo "hey"'
2017/02/03 10:33:25 >>>
hey

<<<
2017/02/03 10:33:25 Listening for messages on: foo

    In the example above, the token is sent using

    nats pub foo 022d59bdf309dc22

    Output

    2017/02/03 10:33:25 Start
2017/02/03 10:33:25 Connected to server:  nats://localhost:4222
2017/02/03 10:33:25 Pushed to channel:  foo
2017/02/03 10:33:25 Message:  022d59bdf309dc22

  5. Subscribe to channel "foo" and trigger a command upon receipt of your own token

    nats sub --cmd 'echo "hey"' --token 12345 foo

    Token sent using

    nats pub foo 12345

  6. For usage within docker-compose, check example-nats-cli-docker-compose

Note on output

nats-cli outputs to stderr instead of stdout, so to capture the output, please use nats ... 2> file.log

Dev notes

To run using local go clone of repo, replace nats in all above examples wtih go run nats.go and run go get installation steps below to instapp the dependencies

Releasing

  1. Pre-requisites
sudo apt-get install golang
export GOPATH=${PWD}

# https://github.com/nats-io/go-nats
go get github.com/nats-io/go-nats

# https://github.com/urfave/cli#using-the-v2-branch
go get gopkg.in/urfave/cli.v2

  1. Edit version number in nats.go

  2. Build binary (copied from gosu)

CGO_ENABLED=0 GOARCH=amd64 go build -v -ldflags '-d -s -w' -o bin/nats-amd64
  1. Test binary (copied from su-exec)
docker run -it -v ${PWD}/bin/nats-amd64:/sbin/nats:ro alpine:latest nats

  1. Add git tag and push

  2. Go to github releases, edit the tag, and upload the newly built binary

TODO

  • integrate tests when this project matures, like ampq