# plotwork icons

> Page: https://docs.plotwork.dev/cli/commands/icons. Index of every page: https://docs.plotwork.dev/llms.txt

Search the bundled icons by name. It is a command of the Plotwork command line, the npm package `@buun_group/plotwork`.

## TL;DR

| Question | Answer |
|---|---|
| What does it do? | Search the bundled icons by name. |
| How do I run it? | `npx -y @buun_group/plotwork@0.1.0 icons`, or `plotwork icons` once the package is installed. |
| What does it write? | Nothing. |
| Does it use the network? | No. It reads and writes files on this machine only. |
| Does it read the repository settings? | No. |
| How do I read this in a terminal? | `plotwork icons --help` |

## Synopsis

```sh
plotwork icons <query>
```

## What it does

Searches the icons bundled with the command line and prints up to 40 matches, one name per line, as it is written in `icon=`. The words of the query are joined, so `plotwork icons api gateway` needs no quotes.

## Options

None.

## Examples

Find the icon names for Postgres.

```sh
plotwork icons postgres
```

## Exit codes

| Code | When |
|---|---|
| `0` | The search ran, whether or not anything matched. |
| `1` | Not used. |
| `2` | No query was given. |

## See also

| Doc | Why |
|---|---|
| [Command reference](https://docs.plotwork.dev/cli/commands.md) | Every command of the command line |
| [Icon names and lookup](https://docs.plotwork.dev/cloud-architecture/icon-names.md) | How icon names are formed |
| [Icon reference](https://docs.plotwork.dev/reference/icons.md) | Every bundled icon |
| [Exit codes and output formats](https://docs.plotwork.dev/cli/exit-codes-and-output.md) | What every code and format means |
