Skip to content

Demisto SDK - Create Demisto Content with ease and efficiency

License

Notifications You must be signed in to change notification settings

avidan-H/my-sdk

This branch is 3065 commits behind demisto/demisto-sdk:master.

Folders and files

NameName
Last commit message
Last commit date
Jul 6, 2020
Apr 1, 2020
Jul 5, 2020
Jul 19, 2020
Jun 30, 2020
Apr 30, 2020
May 3, 2020
May 12, 2020
Mar 28, 2020
Jul 9, 2020
Jul 15, 2020
Apr 5, 2020
Nov 3, 2019
Jun 3, 2020
May 21, 2020
Mar 28, 2020
Jun 22, 2020
Jul 12, 2020
Apr 5, 2020
Mar 28, 2020

Repository files navigation

PyPI version CircleCI Language grade: Python Coverage Status

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
    1. 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. Create
  8. Format
  9. Run
  10. Run-playbook
  11. Upload
  12. Download
  13. Generate-docs
  14. Generate-test-playbook
  15. Json-to-outputs
  16. Create-id-set
  17. Update-release-notes

How to run commands in your development environment

In the Demisto-SDK repository while on the git branch you want to activate and run this command to use python 3.7:

source .tox/py37/bin/activate

or this command to use python 3.8:

For detailed command usage press here


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

About

Demisto SDK - Create Demisto Content with ease and efficiency

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.8%
  • Other 0.2%