xsoar-cli 1.0.0__tar.gz → 1.0.2__tar.gz

{xsoar_cli-1.0.0 → xsoar_cli-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xsoar-cli
-Version: 1.0.0
+Version: 1.0.2
 Project-URL: Documentation, https://github.com/tlium/xsoar-cli#readme
 Project-URL: Issues, https://github.com/tliumb/xsoar-cli/issues
 Project-URL: Source, https://github.com/tlium/xsoar-cli
@@ -26,9 +26,14 @@ Description-Content-Type: text/markdown
 # xsoar-cli
 -----
 This tool is made to help provide a smoother workflow for developers, but also for power users to get useful information out of XSOAR from
-the terminal. Merge requests are very welcome and appreciated!
+the terminal. It is mostly useful if you are using a CICD workflow to deploy your XSOAR content, and most of the functionality assumest that
+you have your content stored in a [content repository](https://github.com/demisto/content-ci-cd-template).
 
-*IMPORTANT NOTE* This CLI tools is made to be run from the root of a content repository. Some commands depends on files located in your
+Pull Requests are very welcome and appreciated!
+
+
+*IMPORTANT NOTE*
+This CLI tools is made to be run from the root of a content repository. Some commands depends on files located in your
 content repository or expects a certain directory structure to be available from your currently working directory.
 
 ## Installation
@@ -47,9 +52,11 @@ The xsoar-cli config file is located in `~/.config/xsoar-cli/config.json`. To cr
 xsoar-cli config create
 ```
 Open up the newly created configuration file and add values that correspond with your environment.
-*IMPORTANT NOTE*: the configuration key `"custom_pack_authors": ["SOMEONE"]` is needed in order for `xsoar-cli` to be able to
-determine which content packs are your own custom content packs and which are supplied from Palo Alto upstream. Use whateve values you may have set in
-pack_metadata.json in the content packs in your content repository.
+
+*IMPORTANT NOTES* 
+- The configuration key `"custom_pack_authors": ["SOMEONE"]` is needed in order for `xsoar-cli` to be able to determine which content packs 
+are your own custom content packs and which are supplied from Palo Alto upstream. Use whatever values you may have set in pack_metadata.json
+ in the content packs in your content repository.
 
 ## Usage
 ```
@@ -62,10 +69,11 @@ For more information on a specific command execute `xsoar-cli <command> --help.`
 ### Commands
 1. [case](src/xsoar_cli/case/README.md)
 2. [config](src/xsoar_cli/config/README.md)
-3. [manifest](src/xsoar_cli/manifest/README.md)
-4. [pack](src/xsoar_cli/pack/README.md)
-5. [playbook](src/xsoar_cli/playbook/README.md)
-6. [plugins](src/xsoar_cli/plugins/README.md)
+3. [graph](src/xsoar_cli/graph/README.md)
+4. [manifest](src/xsoar_cli/manifest/README.md)
+5. [pack](src/xsoar_cli/pack/README.md)
+6. [playbook](src/xsoar_cli/playbook/README.md)
+7. [plugins](src/xsoar_cli/plugins/README.md)
 
 ## Plugin System
 

{xsoar_cli-1.0.0 → xsoar_cli-1.0.2}/README.md

@@ -1,9 +1,14 @@
 # xsoar-cli
 -----
 This tool is made to help provide a smoother workflow for developers, but also for power users to get useful information out of XSOAR from
-the terminal. Merge requests are very welcome and appreciated!
+the terminal. It is mostly useful if you are using a CICD workflow to deploy your XSOAR content, and most of the functionality assumest that
+you have your content stored in a [content repository](https://github.com/demisto/content-ci-cd-template).
 
-*IMPORTANT NOTE* This CLI tools is made to be run from the root of a content repository. Some commands depends on files located in your
+Pull Requests are very welcome and appreciated!
+
+
+*IMPORTANT NOTE*
+This CLI tools is made to be run from the root of a content repository. Some commands depends on files located in your
 content repository or expects a certain directory structure to be available from your currently working directory.
 
 ## Installation
@@ -22,9 +27,11 @@ The xsoar-cli config file is located in `~/.config/xsoar-cli/config.json`. To cr
 xsoar-cli config create
 ```
 Open up the newly created configuration file and add values that correspond with your environment.
-*IMPORTANT NOTE*: the configuration key `"custom_pack_authors": ["SOMEONE"]` is needed in order for `xsoar-cli` to be able to
-determine which content packs are your own custom content packs and which are supplied from Palo Alto upstream. Use whateve values you may have set in
-pack_metadata.json in the content packs in your content repository.
+
+*IMPORTANT NOTES* 
+- The configuration key `"custom_pack_authors": ["SOMEONE"]` is needed in order for `xsoar-cli` to be able to determine which content packs 
+are your own custom content packs and which are supplied from Palo Alto upstream. Use whatever values you may have set in pack_metadata.json
+ in the content packs in your content repository.
 
 ## Usage
 ```
@@ -37,10 +44,11 @@ For more information on a specific command execute `xsoar-cli <command> --help.`
 ### Commands
 1. [case](src/xsoar_cli/case/README.md)
 2. [config](src/xsoar_cli/config/README.md)
-3. [manifest](src/xsoar_cli/manifest/README.md)
-4. [pack](src/xsoar_cli/pack/README.md)
-5. [playbook](src/xsoar_cli/playbook/README.md)
-6. [plugins](src/xsoar_cli/plugins/README.md)
+3. [graph](src/xsoar_cli/graph/README.md)
+4. [manifest](src/xsoar_cli/manifest/README.md)
+5. [pack](src/xsoar_cli/pack/README.md)
+6. [playbook](src/xsoar_cli/playbook/README.md)
+7. [plugins](src/xsoar_cli/plugins/README.md)
 
 ## Plugin System
 

{xsoar_cli-1.0.0 → xsoar_cli-1.0.2}/src/xsoar_cli/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2025-present Torbjørn Lium <torben@lium.org>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "1.0.0"
+__version__ = "1.0.2"

{xsoar_cli-1.0.0 → xsoar_cli-1.0.2}/src/xsoar_cli/case/commands.py

@@ -63,17 +63,21 @@ def clone(ctx: click.Context, casenumber: int, source: str, dest: str) -> None:
 
 
 @click.option("--environment", default="dev", show_default=True, help="Environment as defined in config file")
+@click.option("--casetype", default="", show_default=True, help="Create case of specified type. Default type set in config file.")
 @click.argument("details", type=str, default="Placeholder case details")
 @click.argument("name", type=str, default="Test case created from xsoar-cli")
-@click.command(help="Creates a single new case in XSOAR")
+@click.command()
 @click.pass_context
 @load_config
-def create(ctx: click.Context, environment: str, name: str, details: str) -> None:
+def create(ctx: click.Context, environment: str, casetype: str, name: str, details: str) -> None:
+    """Creates a new case in XSOAR. If invalid case type is specified as a command option, XSOAR will default to using Unclassified."""
     xsoar_client: Client = ctx.obj["server_envs"][environment]
+    if not casetype:
+        casetype = ctx.obj["default_new_case_type"]
     data = {
         "createInvestigation": True,
         "name": name,
-        "type": "MyCaseType",  # grab this from config maybe?
+        "type": casetype,
         "details": details,
     }
     case_data = xsoar_client.create_case(data=data)

{xsoar_cli-1.0.0 → xsoar_cli-1.0.2}/src/xsoar_cli/utilities.py

@@ -80,6 +80,7 @@ def parse_config(config: dict, ctx: click.Context) -> None:
     ctx.obj = {}
     ctx.obj["default_environment"] = config["default_environment"]
     ctx.obj["custom_pack_authors"] = config["custom_pack_authors"]
+    ctx.obj["default_new_case_type"] = config["default_new_case_type"]
     ctx.obj["server_envs"] = {}
     for key in config["server_config"]:
         ctx.obj["server_envs"][key] = Client(