For the complete documentation index, see llms.txt. This page is also available as Markdown.
Cortex XSOAR 6.xCortex XSOAR 8 (SaaS)Cortex XSOAR 8.x (On-premCortex XSIAM

setup-env

Configure the local environment for Demisto SDK and Cortex content development.

The setup-env command creates a content environment and integration/script environment. This command configures VS Code and Cortex XSOAR/XSIAM instances for development and testing. If the GCP project ID is not set, it only configures VS Code.

Notes
  • The setup-env command downloads integration parameters from Google Secret Manager, if the environment variable DEMISTO_SDK_GCP_PROJECT_ID is set to the GCP project ID.

  • The setup-env command creates a virtual environment in the .venv folder if the --create-virtualenv argument is included.

  • The setup-env command configures VS Code debugging and linting for the provided file paths or content repository.

  • If the --instance-name argument is included, the setup-env command creates an integration instance in the Cortex XSOAR or Cortex XSIAM tenant, with the provided file paths or content repository, if a secret was found in Google Secret Manager.

Usage

demisto-sdk setup-env [OPTIONS] [FILE_PATHS]

Arguments
Argument
Description

-i, --input

Path(s) to content integrations or script to setup the environment. If not provided, the default is to configure the environment for the content repository.

--create-virtualenv

Creates a virtualenv for the environment.

--overwrite-virtualenv

Overwrites any existing virtualenv directories. Use with the --create-virtualenv flag.

--secret-id

Secret ID, to use with Google Secret Manager instance. If not provided, the default is to use the integration ID.

--instance-name

Instance name to configure in Cortex XSOAR/XSIAM.

--run-test-module

Whether to run the test module of the integration.

--clean

Cleans the repository of temporary files created by the pre-commit command.

Last updated

Was this helpful?