pactman/README.md

Search Pact & Pactflow documentation from the terminal

# pactman
> Search Pact & Pactflow documentation from the terminal

[![asciicast](https://asciinema.org/a/490546.svg?autoplay=1)](https://asciinema.org/a/490546)

## Use

You can perform searches against [Pact documentation](https://docs.pact.io)  & [Pactflow documentation](https://docs.pactflow.io) without installing `pactman` permanently

```shell
npx pactman
```
  - select which site you want to search ["pact","pactflow"]
  - type search query
  - click/Press Enter on the desired result to open the browser

Or you can install `pactman` globally to be quicker

```shell
npm i -g pactman
```

Then run it via

```shell
pactman
```

[ci image]: https://github.com/you54f/scratchpad/workflows/ci/badge.svg?branch=main
[ci url]: https://github.com/you54f/scratchpad/actions

## Credits

Inspired by https://github.com/bahmutov/cy-search