@clarketm/jwt-cli/README.md

Command line tool for working with JSON Web Tokens (JWT)

# [jwt-cli](https://blog.travismclarke.com/project/jwt-cli/)

[![NPM release](https://img.shields.io/npm/v/@clarketm/jwt-cli.svg)](https://www.npmjs.com/package/@clarketm/jwt-cli)
[![License](https://img.shields.io/npm/l/@clarketm/jwt-cli.svg)](LICENSE.md)

Command line tool for working with JSON Web Tokens (JWT).

<br>
<br>
<a href="https://blog.travismclarke.com/project/jwt-utils/">
  <p align="center"><img width="40%" src="https://github.com/clarketm/jwt-cli/blob/master/hero.png" /></p>
</a>

## Installation

### Yarn

```shell
yarn global add "@clarketm/jwt-cli"
```

### Npm

```shell
npm install --global "@clarketm/jwt-cli"
```

## Demo

![usage demo](https://github.com/clarketm/jwt-cli/blob/master/usage.gif)

## Usage

---

### `sign [options] payload secret`

```shell
$ jwt sign '{"user": "Travis Clarke"}' "super secret"
```

```shell
copied to clipboard:

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhIjoxLCJpYXQiOjE1MjczMTI3NTIsImV4cCI6MTUyNzMxNjM1Mn0.2l4wyaoxNBBY7nvm6sAqAcmXSuuKjBubNo_h42hcigU
```

> Note: the `sign` subcommand accepts **all** the same [**options**](https://github.com/auth0/node-jsonwebtoken#jwtsignpayload-secretorprivatekey-options-callback) as [`auth0/node-jsonwebtoken`](https://github.com/auth0/node-jsonwebtoken) with the exception of `mutatePayload` which is not applicable.

| Option             | Description                                         |
| ------------------ | --------------------------------------------------- |
| `-n, --noCopy`     | Do not copy the token to the clipboard.             |
| `-p, --passphrase` | The passphrase for your secret (if it is encrypted) |

---

### `verify [options] token secret`

```shell
$ jwt verify "eyJhbGciOiJIUzI1..." "super secret"
```

```
valid!
```

> Note: the `verify` subcommand accepts **all** the same [**options**](https://github.com/auth0/node-jsonwebtoken#jwtverifytoken-secretorpublickey-options-callback) as [`auth0/node-jsonwebtoken`](https://github.com/auth0/node-jsonwebtoken)

---

### `decode [options] token`

```shell
$ jwt decode "eyJhbGciOiJIUzI1..."
```

```shell
copied to clipboard:

{
  user: 'Travis Clarke',
  iat: 1537507542,
  exp: 1537511142
}
```

> Note: the `decode` subcommand accepts **all** the same [**options**](https://github.com/auth0/node-jsonwebtoken#jwtverifytoken-secretorpublickey-options-callback) as [`auth0/node-jsonwebtoken`](https://github.com/auth0/node-jsonwebtoken) with the exception of `json` which is not applicable.

| Option         | Description                               |
| -------------- | ----------------------------------------- |
| `-n, --noCopy` | Do not copy the payload to the clipboard. |

---

## Related

- [node-jsonwebtoken](https://github.com/auth0/node-jsonwebtoken) – JsonWebToken implementation for node.js

## License

MIT &copy; [**Travis Clarke**](https://blog.travismclarke.com/)