Demisto SDK

The Demisto SDK library can be used to manage your Demisto content with ease and efficiency. The library uses python 3.7+.

Usage

Installation

1. Install - pip3 install demisto-sdk

2. Upgrade - pip3 install --upgrade demisto-sdk

3. Demisto server demisto-sdk integration - In order that demisto-sdk and Demisto server communicate, perfrom the following steps:

   1. Get an API key for Demisto-server - Settings -> Integrations -> API keys -> Get your Key (copy it, you will be to copy it once)
   2. Add the following parameters to ~/.zshrc and ~/.bash_profile:

   export DEMISTO_BASE_URL=<http or https>://<demisto-server url or ip>:<port>
   export DEMISTO_API_KEY=<API key>

   for example:

   export DEMISTO_BASE_URL=http://127.0.0.1:8080
   export DEMISTO_API_KEY=XXXXXXXXXXXXXXXXXXXXXX

   3. Reload your terminal before continue.

---

CLI usage

You can use the SDK in the CLI as follows:

demisto-sdk <command> <args>

For more information, run demisto-sdk -h. For more information on a specific command execute demisto-sdk <command> -h.

---

Commands

Supported commands:

1. init
2. Validate
3. Lint
4. Secrets
5. Unify
6. Split-yml
7. Format
8. Run
9. Run-playbook
10. Upload
11. Download
12. Generate-docs
13. Generate-test-playbook
14. Json-to-outputs
15. Update-release-notes
16. openapi-codegen

---

How to setup development environment?

Follow the guide found here to setup your demisto-sdk-dev virtual environment. The development environment is connected to the branch you are currently using in the SDK repository.

Simply activate it by running workon demisto-sdk-dev. The virtual environment can be deactivated at all times by running deactivate.

---

Autocomplete

Our CLI supports autocomplete for Linux/MacOS machines, you can turn this feature on by running one of the following: for zsh users run in the terminal

eval "$(_DEMISTO_SDK_COMPLETE=source_zsh demisto-sdk)"

for regular bashrc users run in the terminal

eval "$(_DEMISTO_SDK_COMPLETE=source demisto-sdk)"

---

License

MIT - See LICENSE for more information.

---

Contributions

Contributions are welcome and appreciated.
For information regarding contributing, press here. For release guide, press here