Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

elaborate scripts.json part #4

Merged
merged 6 commits into from
Aug 1, 2016
+15 −2
Merged

elaborate scripts.json part #4

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8236b99
elaborate scripts.json part
meirwah Aug 1, 2016
1c17851
Expanded on scripts.json
liorkol Aug 1, 2016
7f37fa1
Merge branch 'master' into elaborate-scripts.json
liorkol Aug 1, 2016
f6d273b
Final touches
liorkol Aug 1, 2016
ecda036
Phrasing.
liorkol Aug 1, 2016
9fd8653
Phrasing
liorkol Aug 1, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 15 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ Here is a description of scripts.json fields and structure:
"name": "RemoteExec",
"script": "RemoteExec.js",
"type": "javascript",
"visualScript": "",
"tags": ["endpoint"],
"arguments": [
{
Expand All @@ -43,5 +42,19 @@ Here is a description of scripts.json fields and structure:
},
```

* name: Name for the script, that will be displayed in the Automation page
* script: The name of the file containing the script itself
* type: javascript or python
* tags: array of tags of the script
* arguments: array of script arguments
* name: argument name
* description: argument description - appears in automation page and in the CLI autocomplete
* required: Whether the user must provide this argument to run the script - yes for mandatory, no for optional
* default: (Only one "yes" per script) Argument can be provided without its name - e.g. !whois google.com instead of !whois domain=google.com
* comment: A brief description of the script's purpose and any other important things to know - appears in the Automation page and in the CLI autocomplete.
* system: "yes" if the script is provided with the platform and is locked and unmodifiable - set to "no" for scripts user creates from within the product.
* scriptTarget: 0 for server script, 1 for agent script (to be run on endpoint)
* dependsOn: The commands required for the script to be used - if these commands are unavailable (e.g. because no integration that implements them has been configured) then the script will not appear in the CLI's autocomplete (it can still be viewed and edited on the Automation page).

If you have a suggestion or an opportunity for improvement that you've identified, please open an issue in this repo.
Enjoy and feel free to reach out to us on the [DFIR Community Slack channel](https://www.demisto.com/community/), or at [info@demisto.com](mailto:info@demisto.com)
Enjoy and feel free to reach out to us on the DFIR Community Slack channel, or at info@demisto.com