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
-
Install -
pip3 install demisto-sdk -
Upgrade -
pip3 install --upgrade demisto-sdk -
Demisto server demisto-sdk integration - In order that demisto-sdk and Demisto server communicate, perfrom the following steps:
- Get an API key for Demisto-server -
Settings->Integrations->API keys->Get your Key(copy it, you will be to copy it once) - Add the following parameters to
~/.zshrcand~/.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
- Reload your terminal before continue.
- Get an API key for Demisto-server -
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:
- init
- Validate
- Lint
- Secrets
- Unify
- Split-yml
- Format
- Run
- Run-playbook
- Upload
- Download
- Generate-docs
- Generate-test-playbook
- Json-to-outputs
- Update-release-notes
- openapi-codegen
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
Release files for demisto-sdk 1.1.10
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| demisto-sdk-1.1.10.tar.gz | 1.2 MB | Details |
Release files / demisto-sdk-1.1.10.tar.gz
| Download URL | demisto-sdk-1.1.10.tar.gz |
|---|---|
| Size | 1.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0697af798d7db4977a38bee3ee05022757dbd9f1935e0648060603639309fd5e
|
|
BLAKE2b-256 checksum How to use checksums |
ba24d59dae238454b0dfc431ae9506b521dba7bb22c666e253d9646136b03865
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.3.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.5
|