https://github.com/prashanthpai/sqscat
A netcat/kafkacat like utility for AWS SQS.
https://github.com/prashanthpai/sqscat
aws aws-sqs go golang jq kafkacat kcat netcat sqs sqs-cli sqs-client sqs-consumer sqs-queue sqscat
Last synced: 3 months ago
JSON representation
A netcat/kafkacat like utility for AWS SQS.
- Host: GitHub
- URL: https://github.com/prashanthpai/sqscat
- Owner: prashanthpai
- License: mit
- Created: 2021-09-20T11:37:44.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-12-23T17:01:44.000Z (over 1 year ago)
- Last Synced: 2025-09-02T12:27:28.861Z (8 months ago)
- Topics: aws, aws-sqs, go, golang, jq, kafkacat, kcat, netcat, sqs, sqs-cli, sqs-client, sqs-consumer, sqs-queue, sqscat
- Language: Go
- Homepage:
- Size: 31.3 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sqscat
[](https://goreportcard.com/report/github.com/prashanthpai/sqscat)
[](https://opensource.org/licenses/MIT)
sqscat is "netcat for SQS". You can use sqscat to receive from and send
messages to SQS queue. sqscat uses newline as the delimiter between messages.
sqscat automatically detects and selects its mode (receive/send) depending
on the terminal or pipe type:
* If data is being piped into sqscat (stdin), it sends messages to SQS.
* If data is being piped from sqscat (stdout), it receives messages from SQS.
sqscat is inspired by [kafkacat](https://github.com/edenhill/kafkacat).
### Install
You can download built binaries for Mac, Linux and Windows from the
[releases](https://github.com/prashanthpai/sqscat/releases) page.
### Usage
**Note:** sqscat uses AWS SDK which will automatically load access and region
configuration from environment variables, AWS shared configuration file
(`~/.aws/config`), and AWS shared credentials file (`~/.aws/credentials`).
```sh
$ sqscat --help
Usage:
sqscat [OPTIONS] queue-name
Application Options:
-v, --version Print version and exit
-c, --concurrency= Number of concurrent SQS receivers/senders; Defaults to 10 x Num. of CPUs
-d, --delete Delete received messages
-n, --num-messages= Receive/send specified number of messages and exit; This limits concurrency to 1
-t, --timeout= Exit after specified number of seconds
Help Options:
-h, --help Show this help message
```
#### Examples
**Receive mode:**
Keep reading json payloads from queue and extract individual fields using [jq](https://stedolan.github.io/jq/):
```sh
$ sqscat my-sqs-queue | jq --unbuffered '.employee.email'
```
Read 25 messages from queue and exit:
```sh
$ sqscat -n 25 my-sqs-queue
```
Keep reading from queue for 10 seconds and exit:
```sh
$ sqscat -t 10 my-sqs-queue
```
Delete received messages after they have been printed to stdout:
```sh
$ sqscat -d my-sqs-queue
```
**Send mode:**
Parse json and keep sending messages to the queue. sqscat will exit after the
input pipe has been closed (EOF).
```sh
$ cat employees.json | jq --unbuffered '.employee.email' | ./sqscat dev-ppai-temp
```
Send 25 messages to the queue and exit:
```sh
$ cat employees.json | jq --unbuffered '.employee.email' | sqscat -n 25 my-sqs-queue
```