# Secator docs

## Secator docs

- [Introduction](https://docs.freelabz.com/getting-started/readme.md): ... or what secator is all about.
- [Installation](https://docs.freelabz.com/getting-started/installation.md): ... or how to install secator and it's dependencies on different platforms.
- [CLI Usage](https://docs.freelabz.com/getting-started/cli-usage.md): ... or how you can use secator as your pentesting swiss-knife.
- [Library usage](https://docs.freelabz.com/getting-started/library-usage.md): ... or how you can use secator as a foundation to build powerful security software.
- [Configuration](https://docs.freelabz.com/getting-started/configuration.md): ... how to configure every aspect of how secator operates.
- [Examples](https://docs.freelabz.com/getting-started/examples.md): ... or concrete use cases for secator.
- [5 minutes secator session](https://docs.freelabz.com/getting-started/examples/5-minutes-secator-session.md): or how you can hack faster than ever before...
- [Global options](https://docs.freelabz.com/runner-options/task-options.md): ... or options that you can use in any context.
- [Meta options](https://docs.freelabz.com/runner-options/meta-options.md): ... or options that are mutualized among task categories for efficiency, speed, and user-friendliness.
- [Input formats](https://docs.freelabz.com/runner-options/input-formats.md): ... or how to pass targets to secator.
- [Output options](https://docs.freelabz.com/runner-options/output-options.md): ... or how to change secator's console output.
- [Philosophy & design](https://docs.freelabz.com/in-depth/philosophy-and-design.md): ... or the core concepts behind the pillars of secator.
- [Distributed runs with Celery](https://docs.freelabz.com/in-depth/distributed-runs-with-celery.md): ... or how you can 10x your scanning speed and massively parallelize your workflows.
- [Concepts](https://docs.freelabz.com/in-depth/concepts.md): ... or foundational blocks that you must understand in order to go deeper.
- [Output types](https://docs.freelabz.com/in-depth/concepts/output-types.md): ... or how secator unifies all output into common schemas.
- [Proxies](https://docs.freelabz.com/in-depth/concepts/proxies.md): ... or how to control how secator connects to targets.
- [Exporters](https://docs.freelabz.com/in-depth/concepts/exporters.md): ... or how to export reports to different destinations.
- [Runners](https://docs.freelabz.com/in-depth/concepts/runners.md): ... or how secator's internals work.
- [Drivers](https://docs.freelabz.com/in-depth/concepts/drivers.md): ... or how to route live results to a destination.
- [Profiles](https://docs.freelabz.com/in-depth/concepts/profiles.md): ... or how to manage different runner option sets effectively.
- [Deployment](https://docs.freelabz.com/in-depth/deployment.md): ... or how to run secator anywhere.
- [Development setup](https://docs.freelabz.com/for-developers/development-setup.md): ... or how to setup a development environment for secator.
- [Writing tasks](https://docs.freelabz.com/for-developers/writing-tasks.md): ... or how to integrate new tasks with secator.
- [Integrating an external command](https://docs.freelabz.com/for-developers/writing-tasks/integrating-an-external-command.md): ... or how to turn a command that you use daily into an overpowered machine.
- [Parsing JSON lines](https://docs.freelabz.com/for-developers/writing-tasks/integrating-an-external-command/parsing-json-lines.md): ... or how to integrate tools that output JSON lines.
- [Parsing raw standard output](https://docs.freelabz.com/for-developers/writing-tasks/integrating-an-external-command/parsing-raw-standard-output.md): ... or how to integrate tools that prints to stdout and do not support JSON lines.
- [Parsing output files](https://docs.freelabz.com/for-developers/writing-tasks/integrating-an-external-command/parsing-output-files.md): ... or how to integrate tools that save their output to a file.
- [Example: integrating ls](https://docs.freelabz.com/for-developers/writing-tasks/integrating-an-external-command/example-integrating-ls.md): ... or how to integrate a command without JSON output.
- [Example: cat hunters](https://docs.freelabz.com/for-developers/writing-tasks/integrating-an-external-command/example-cat-hunters.md): ... or how to integrate groups of tasks with similar options.
- [Integrate custom Python code \[WIP\]](https://docs.freelabz.com/for-developers/writing-tasks/integrate-custom-python-code-wip.md): How to create custom tasks using pure Python code without external commands.
- [Advanced options](https://docs.freelabz.com/for-developers/writing-tasks/advanced-options.md)
- [Writing workflows](https://docs.freelabz.com/for-developers/writing-workflows.md): ... or how to integrate new workflows with secator.
- [Writing scans \[WIP\]](https://docs.freelabz.com/for-developers/writing-scans-wip.md): ... or how to integrate new scans with secator.


---

# 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, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on a page URL with the `ask` query parameter:
```
GET https://docs.freelabz.com/getting-started/readme.md?ask=<question>
```
The question should be specific, self-contained, and written in natural language.
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.