CLI

We provide a command-line interface for interacting with Microlink API from your terminal, available as an

npm install @microlink/cli --global

Alternatively, if you have

, you can just run it.

npx install @microlink/cli --help

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


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