Our recommended OS for development is either macOS or Linux, as we use bash and docker in some of our validation/testing flows.
If you are working on Windows, you can either work with a Linux VM or utilize Windows Subsystem for Linux.
We use GitHub (as you can see). See: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git for git client install instructions.
Our repository utilizes both Python 2 (2.7 and up) and Python 3 (3.7 and up). Make sure to install both versions.
We recommend managing python versions via pyenv
Optionally, macOS users can install via homebrew.
Docker is an optional, but highly recommended install. If you would like to write unit tests and run them, as we do in our CI process (within docker), we recommend installing docker. See: https://docs.docker.com/install/ for install options.
Setting Up a Development Environment
Clone (Cortex XSOAR users) or Fork (external contributors) the Cortex XSOAR Content repository.
Install Python virtualenv
We recommend using virtualenv to create an isolated virtual python development environment. To install virtual env run:
pip install virtualenv
Note: Python 3 includes the
venv module for creating virtual envs, but it does not permit creating virtual envs with other versions of Python (such as Python 2). Thus, we use the
virtualenv is installed you can run the
bootstrap script. The script will setup a pre-commit hook which will validate your modified files before committing and setup a python virtual env for development with the package requirements for python2 and python3. Run the script from the root directory of the source tree:
After completing, you can activate the newly created virtual env by running:
Note: To ease setup, by default for forked repositories we don't setup Python 2 as part of the virtual env setup. If you require Python 2 for your automations/integrations run the
.hooks/bootstrap script with the environment variable set:
SETUP_PY2=yes. When run with
SETUP_PY2=yes set, the virtualenv built contains both Python 2 and 3.
python2 will point to Python 2 and
python3 to Python 3.
This is our help tool that will make your lives easier during the contribution process, it will help you generate a
Pack. And will help you maintain your files and validate them before committing to the branch. It is installed via our
Boostrap process. If for prefer to install the
demisto-sdk manually see instructions here.
To check the you have the latest version of the sdk run:
Congratulations! You now have a fully configured virtual env, where you can run our different validation and utility scripts. For example, to convert an exported yml integration to our package (directory) format, you can use the
demisto-sdk utility. Try:
demisto-sdk split-yml --help
Cortex XSOAR offers two IDEs for developing: