## Table of Contents

- [CLI](#cli)

---

## CLI

We provide a command-line interface for interacting with [Microlink API](https://microlink.io/docs/api/getting-started/overview) from your terminal, available as an [](https://www.npmjs.com/package/@microlink/cli)

[npm package](https://www.npmjs.com/package/@microlink/cli)

.

npm install @microlink/cli --global

Alternatively, if you have [](https://www.npmjs.com/package/npx)

[npx](https://www.npmjs.com/package/npx)

, you can just run it.

npx @microlink/cli --help

After that, `microlink` command will be available in your system.

```bash
microlink <url> [flags]

Flags

  --api-key      authenticate using an API key (default is `$MICROLINK_API_KEY`

  --colors       colorize output (default is `true`

  --copy         copy output to clipboard (default is `false`).

  --pretty       beauty response payload (default is `true`).

Examples

  microlink https://microlink.io&palette

  microlink https://microlink.io&palette --no-pretty

  microlink https://microlink.io&palette --api-key MY_API_KEY
```