# nest

nest is the official CLI companion of Parrot Security Linux. It ships a
curated catalog of the security tools provided by the Parrot project and
answers two questions:

1. Which tools exist, and which of them are installed on this system?
2. How do I launch a tool — locally, or inside a podman/docker container?

## Usage

```
nest list [--all | --installed | --available] [--json]
nest search <term> [--json]
nest info <tool> [--json]
nest run <tool> [--local | --container] [--runtime podman|docker] [--image <ref>] [-- <args>...]
nest cleanup [--running] [--images] [--dry-run] [--yes] [--json]
nest refresh [--runtime podman|docker] [--json]
nest version [--json]
```

See `nest <command> --help`, the nest(1) man page, and `AGENTS.md` (the
single source of truth for behavior and architecture).

## Build

```sh
go build ./...
go test ./...
go build -ldflags "-X main.version=$(git describe --tags --always)" -o nest ./src
```

Debian packaging lives in `debian/`; build with `dpkg-buildpackage -us -uc -b`.

## License

GNU General Public License v3.0 or later — see the LICENSE file.
