> For the complete documentation index, see [llms.txt](https://docs.meterian.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.meterian.io/online-integrations/meterian-scanner-github-action.md).

# GitHub Action

The [Meterian Scanner GitHub Action](https://github.com/marketplace/actions/meterian-scanner) enables you to automate a vulnerability scan of your codebase right from the GitHub repository.

Our action can be triggered by any GitHub workflow event, and combined with countless existing actions giving you the freedom to customise your software development workflow around it however you please.

Follow the [first scan guide](/the-client/guide-your-first-scan/your-first-scan-github-action.md) to set our action up in your repository, or find out more about it on the [documentation on GitHub](https://github.com/marketplace/actions/meterian-scanner) to learn about its configuration and how to integrate it into your existing workflow.&#x20;

Please note that in order to use this integration for private codebases you will need to be on any of our paid plans.

A list of working examples for all the supported languages can be found [here](https://github.com/marketplace/actions/meterian-scanner#examples).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.meterian.io/online-integrations/meterian-scanner-github-action.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
