generate-docs - Demisto SDK Guide - Cortex - Security Operations

Demisto SDK Guide

Creation date
2023-08-01
Last date published
2024-04-01
Category
Demisto SDK Guide
Abstract

The generate-docs command generates a readme file for your integration, script, or playbook, for documentation purposes.

Generates a readme file for your integration, script or playbook. Used to create documentation files for Cortex XSOAR.

Note

This command is not supported in Cortex XSIAM.

This command creates a new README.md file in the same directory as the entity on which it ran, unless otherwise specified using the -o flag. To generate command examples, set up the required environment variables prior to running this command in order to establish a connection between the Demisto SDK and the server, as well as create a file containing command examples to be run for the documentation.Demisto SDK