# seaquest-cli

> A simplified tool for quick restful requests

Latest version **1.0.5-beta** (published 2018-08-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install seaquest-cli
pnpm add seaquest-cli
yarn add seaquest-cli
bun add seaquest-cli
```

Provides the command `seaquest`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.5-beta |
| Published | 2018-08-30 |
| First published | 2018-08-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 17.8 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Maurício Fedatto |
| Maintainers | mauriciofedatto |
| Keywords | rest, request, httpclient, client, seaquest, sea, quest, mfedatto |

## Links

- npm: https://www.npmjs.com/package/seaquest-cli
- Repository: https://github.com/mfedatto/seaquest-cli
- Homepage: https://github.com/mfedatto/seaquest-cli#readme
- Issues: https://github.com/mfedatto/seaquest-cli/issues
- npm.io page: https://npm.io/package/seaquest-cli

## Dependencies (7)

- [ajv](https://npm.io/package/ajv.md) ^6.5.3
- [chalk](https://npm.io/package/chalk.md) ^2.4.1
- [eslint](https://npm.io/package/eslint.md) ^5.4.0
- [request](https://npm.io/package/request.md) ^2.88.0
- [ajv-keywords](https://npm.io/package/ajv-keywords.md) ^3.2.0
- [system-sleep](https://npm.io/package/system-sleep.md) ^1.3.6
- [command-line-args](https://npm.io/package/command-line-args.md) ^5.0.2

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 1.0.5-beta (latest) — 2018-08-30
- 1.0.4-beta — 2018-08-30
- 1.0.3-beta — 2018-08-27
- 1.0.2-beta — 2018-08-25

## README

# Seaquest-CLI

Seaquest is a command-line tool for quick restful requests directly from the command-line.

## Getting started

To run Seaquest, make sure you have Node.js v6 or higher. [Install Node.js via package manager](https://nodejs.org/en/download/package-manager/).

### Installation

The easiest way to install Seaquest is using `npm`. If you have Node.js installed, it is most likely that you have `npm`
installed as well.

```console
$ npm install -g seaquest-cli
```

This installs Seaquest globally on your system allowing you to run it from anywhere. If you want to install it locally,
Just remove the `-g` flag.

## Usage

### Using Seaquest CLI

The `seaquest` command allows you to specify an endpoint to be called.

```console
$ seaquest https://api.ipify.org
```

If you have arguments to send in your request, just use the parameter `-a`, `--arguments`.

```console
$ seaquest http://www.omdbapi.com -a apikey=297b81a2 t=seaquest
```

### Command Arguments

For the complete list or arguments you may inform `-?`, `--help` argument.

| Argument                    | Default | Type       | Multiple | Description | Example |
| --------------------------- |:------- |:---------- |:--------:|:----------- |:------- |
| `-e`, `--endpoint`          |         | `String`   | No       | The remote address for the calling endpoint. The argument name may be suppressed when its value is the first argument | `seaquest https://api.ipify.org` |
| `-a`, `--arguments`         |         | `String[]` | Yes      | The key and value strings for the arguments to be sent | `-a apikey=297b81a2 t=seaquest` |
| `-m`, `--method`            | `GET`   | `String`   | No       | The method to be used for calling the endpoint | `seaqeuest https://api.ipify.org -m GET` |
| `-h`, `--headers`           |         | `String[]` | Yes      | The key and value strings for the headers to be sent | `-h "X-User-Token: 1a2b3c4d" "X-Client-Agent: Seaquest-CLI"` |
| `-t`, `--timeout`           | `30000` | `Number`   | No       | The millisecond amount limit for receiving a response | `-t 10000` |
| `-b`, `--body`              |         | `String`   | No       | The body content to be sent on request | `-b { "id": "string", "length": 5 }` |
| `-i`, `--iteration`         | `1`     | `Number`   | No       | The number calls to be made. When higher than 1 the output is reduced. | `-i 5` |
| `-r`, `--iterationsIntervalTime` | `1000`  | `Number`   | No       | The millisecond interval between iterations calls | `-r 5000` |
| `-l`, `--responseLimit`     | `5120`  | `Number`   | No       | The maximum size of response body to output in the console | `-l 300` |
| `-u`, `--uncutResponse`     | `false` | `Boolean`  | No       | Indicates if the response should not be limited | `-u` |
| `-j`, `--json`              | `false` | `Boolean`  | No       | Indicates if the response should be displayed as `JSON` | `-j` |
| `-v`, `--verbose`           | `false` | `Boolean`  | No       | Indicates if Seaquest should output all information about both request and response | `-v` |
| `-?`, `--help`              | `false` | `Boolean`  | No       | Indicates if help info should be shown instead of making any call to an endpoint | `-?` |

## Contributing

Please take a moment to analyse our [source code](https://github.com/mfedatto/seaquest-cli).
Open an [issue](https://github.com/mfedatto/seaquest-cli/issues) first to discuss potential changes/additions.

---
_Source: https://npm.io/package/seaquest-cli · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._