Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📃 gif examples for readme #335

Merged
merged 1 commit into from
Oct 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,13 @@

`cnquery` is a cloud-native tool for querying your entire fleet. It answers thousands of questions about your infrastructure, and integrates with over 300 resources across cloud accounts, Kubernetes, containers, services, VMs, APIs, and more.

![cnquery run example](docs/gif/cnquery-run.gif)

Here are a few more examples:

```bash
# run a query and print the output
cnquery run local -c "packages.installed { name version }"
cnquery run local -c "ports.listening { port process }"

# execute a query pack on a Docker image and print results as json
cnquery scan docker 14119a -f pack.mql.yaml -j
Expand Down Expand Up @@ -97,9 +101,11 @@ cnquery scan local --pack incident-response --query-id sth-01
Custom query packs let you bundle queries to meet your specific needs. You can find a simple query pack example in `examples/simple.mql.yaml`. To run it:

```bash
cnquery scan local -f examples/simple.mql.yaml
cnquery scan local -f examples/example-os.mql.yaml
```

![](docs/gif/cnquery-scan.gif)

These files can also contain multiple query packs for many different target systems. For an example, see `examples/multi-target.mql.yaml`.

## Distributing cnqueries across your fleet
Expand Down
Binary file added docs/gif/cnquery-run.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/gif/cnquery-scan.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,11 @@ packs:
- title: Find all SSH packages that are installed
query: |
packages.
where(name == /ssh/).
list
where(name == /ssh/)
- title: Get SSH services
query: |
services.
where(name == /ssh/).
list
where(name == /ssh/)
- title: All the SSH config
query: |
sshd.config.params