2021-05-14 17:38:33 +00:00
# Standard query library
2022-03-29 04:39:20 +00:00
Fleet's [standard query library ](https://fleetdm.com/queries ) includes a growing collection of useful policies and miscellaneous queries for organizations deploying Fleet and osquery.
2021-05-14 17:38:33 +00:00
## Importing the queries in Fleet
2021-10-22 18:41:17 +00:00
### After cloning the fleetdm/fleet repo, import the queries using fleetctl:
2021-05-14 17:38:33 +00:00
```
2021-10-20 23:53:01 +00:00
fleetctl apply -f docs/01-Using-Fleet/standard-query-library/standard-query-library.yml
2021-05-14 17:38:33 +00:00
```
## Contributors
Want to add your own query?
2022-04-29 14:18:13 +00:00
1. Please copy the following YAML section and paste it at the bottom of the [`standard-query-library.yml` ](./standard-query-library.yml ) file.
2021-10-28 15:24:52 +00:00
```yaml
---
apiVersion: v1
kind: query
spec:
2022-04-29 14:18:13 +00:00
name: What is your query called? Please use a human-readable query name.
2021-10-28 15:24:52 +00:00
platforms: What operating systems support your query? This can usually be determined by the osquery tables included in your query. Heading to the https://osquery.io/schema webpage to see which operating systems are supported by the tables you include.
2022-04-28 16:21:59 +00:00
description: Describe your query. What information does your query reveal? (optional)
2021-10-28 15:24:52 +00:00
query: Insert query here
purpose: What is the goal of running your query? Ex. Detection
remediation: Are there any remediation steps to resolve the detection triggered by your query? If not, insert "N/A."
contributors: zwass,mike-j-thomas
2022-04-29 14:18:13 +00:00
tags: Keywords that can help users find other relevant queries; each tag should be separated by a comma. (e.g., "foo,bar")
2021-10-28 15:24:52 +00:00
```
2021-05-14 17:38:33 +00:00
2. Replace each field and submit a pull request to the fleetdm/fleet GitHub repository.
2021-12-06 15:15:05 +00:00
3. If you want to contribute multiple queries, please open one pull request that includes all your queries.
2022-04-29 14:18:13 +00:00
For instructions on submitting pull requests to Fleet, check out [the Committing Changes
2022-02-23 18:17:55 +00:00
section](../../Contributing/Committing-Changes.md#committing-changes) in the Contributors
2021-12-06 15:15:05 +00:00
documentation.
2021-05-14 17:38:33 +00:00
## Additional resources
Listed below are great resources that contain additional queries.
- Osquery (https://github.com/osquery/osquery/tree/master/packs)
2021-05-18 15:33:40 +00:00
- Palantir osquery configuration (https://github.com/palantir/osquery-configuration/tree/master/Fleet)