# Kusho CLI
### What is KushoAI?
KushoAI is an **AI-powered API testing agent** that helps developers by **generating extensive test suites for APIs within minutes**. If you’re tired of manual testing after every small update or want more reliable monitoring to catch errors before they hit production, KushoAI can help. Simply provide your API information, and KushoAI will generate real-world test cases that are ready to execute.
`kusho-cli` is the command-line tool for using KushoAI to generate and run test suites directly from your terminal. For the full range of features, try the [KushoAI web application](https://kusho.ai).
## Installation
To install the `kusho-cli` tool, use:
```bash
pip install kusho-cli
```
### Usage
- Invoke `kusho-cli` using this
```bash
kusho-cli
```
- You will be prompted to enter details about your API like HTTP method, URL, headers, query/path params, request body.
- Wait while KushoAI generates tests for your API using above entered details. This generally takes 2-3 minutes.
- Once the generation is completed, you'll see the tests displayed as a numbered list. Use the number to run a test like this
```bash
--------------------
Test Case 12:
{"description": "Test with a valid identifier in Roman numeral format for 'query_params.key'", "request": {"method": "get", "url": "https://localhost:8080/hello", "api_desc": "", "headers": {}, "path_params": {}, "query_params": {"key": "V"}, "json_body": {}}, "categories": ["Other"], "types": ["Business Logic"], "fields": ["query_params.key"], "uuid": "f01a9524-14d1-41df-9b9b-dc6a039d0e03", "test_suite_id": 19019}
--------------------
Test Case 13:
{"description": "Test without the 'key' identifier field in 'query_params'", "request": {"method": "get", "url": "https://localhost:8080/hello", "api_desc": "", "headers": {}, "path_params": {}, "query_params": {"key": ""}, "json_body": {}}, "categories": ["Other"], "types": ["Business Logic"], "fields": ["query_params.key"], "uuid": "77061233-4e70-40df-9fbd-a5abac5bce85", "test_suite_id": 19019}
--------------------
Test Case 14:
{"description": "Test with an invalid format of Identifier for 'query_params.key'", "request": {"method": "get", "url": "https://localhost:8080/hello", "api_desc": "", "headers": {}, "path_params": {}, "query_params": {"key": "invalidFormat"}, "json_body": {}}, "categories": ["Other"], "types": ["Business Logic"], "fields": ["query_params.key"], "uuid": "c6828701-d441-4560-81bb-55d6395ba6b2", "test_suite_id": 19019}
--------------------
Test Case 15:
{"description": "Test with mixed case characters in the 'key' identifier field in 'query_params'", "request": {"method": "get", "url": "https://localhost:8080/hello", "api_desc": "", "headers": {}, "path_params": {}, "query_params": {"key": "mIxEdCaSe"}, "json_body": {}}, "categories": ["Other"], "types": ["Business Logic"], "fields": ["query_params.key"], "uuid": "cd9c2587-0826-408e-a7e9-65286c627481", "test_suite_id": 19019}
--------------------
Test Case 16:
{"description": "Test with a valid format for the 'key' identifier field in 'query_params'", "request": {"method": "get", "url": "https://localhost:8080/hello", "api_desc": "", "headers": {}, "path_params": {}, "query_params": {"key": "validIdentifier"}, "json_body": {}}, "categories": ["Other"], "types": ["Business Logic"], "fields": ["query_params.key"], "uuid": "a946b37a-f183-432f-89ec-f31203a1cac3", "test_suite_id": 19019}
--------------------
Test Case 17:
{"description": "Test with a negative value for the 'key' identifier field in 'query_params'", "request": {"method": "get", "url": "https://localhost:8080/hello", "api_desc": "", "headers": {}, "path_params": {}, "query_params": {"key": -123}, "json_body": {}}, "categories": ["Other"], "types": ["Business Logic"], "fields": ["query_params.key"], "uuid": "06b3c5f0-f7d7-49ee-bed3-3a130a7940d3", "test_suite_id": 19019}
--------------------
Test Case 18:
{"description": "Test with an identifier containing punctuation for the 'key' identifier field in 'query_params'", "request": {"method": "get", "url": "https://localhost:8080/hello", "api_desc": "", "headers": {}, "path_params": {}, "query_params": {"key": "punct;uation"}, "json_body": {}}, "categories": ["Other"], "types": ["Business Logic"], "fields": ["query_params.key"], "uuid": "efb5fb98-da95-487c-8516-3c18d5900072", "test_suite_id": 19019}
--------------------
Test Case 19:
{"description": "Test with an identifier containing emojis for the 'key' identifier field in 'query_params'", "request": {"method": "get", "url": "https://localhost:8080/hello", "api_desc": "", "headers": {}, "path_params": {}, "query_params": {"key": "emojis\ud83d\ude00"}, "json_body": {}}, "categories": ["Other"], "types": ["Business Logic"], "fields": ["query_params.key"], "uuid": "6021f63a-0192-4e2d-9410-c2c56f2b6732", "test_suite_id": 19019}
--------------------
Select an option:
1. List all test cases
2. Execute all test cases
3. Run a specific test case
4. Exit
> 3 17
```
- Alternatively, you can run all tests using option 2
For a detailed product walkthrough of the KushoAI web application, you can watch the video [here](https://www.youtube.com/watch?v=4z4pI5N0_7o).
<br>
> NOTE: This CLI version of KushoAI has limited features at the moment. For our full suite of features, you can use the [KushoAI web application](https://kusho.ai).
Raw data
{
"_id": null,
"home_page": "https://github.com/kusho-co/pip-kusho-cli",
"name": "kusho-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": null,
"author": "KushoAI",
"author_email": "support@kusho.ai",
"download_url": "https://files.pythonhosted.org/packages/84/25/75deb69caf7e3ee7c144e41cf42fdcee08a0851f4c4feda222a89f337df4/kusho_cli-0.1.4.tar.gz",
"platform": null,
"description": "# Kusho CLI\n\n### What is KushoAI?\n\nKushoAI is an **AI-powered API testing agent** that helps developers by **generating extensive test suites for APIs within minutes**. If you\u2019re tired of manual testing after every small update or want more reliable monitoring to catch errors before they hit production, KushoAI can help. Simply provide your API information, and KushoAI will generate real-world test cases that are ready to execute.\n\n`kusho-cli` is the command-line tool for using KushoAI to generate and run test suites directly from your terminal. For the full range of features, try the [KushoAI web application](https://kusho.ai).\n\n## Installation\n\nTo install the `kusho-cli` tool, use:\n\n```bash\npip install kusho-cli\n```\n\n\n### Usage\n\n- Invoke `kusho-cli` using this\n```bash\nkusho-cli\n```\n- You will be prompted to enter details about your API like HTTP method, URL, headers, query/path params, request body.\n- Wait while KushoAI generates tests for your API using above entered details. This generally takes 2-3 minutes.\n- Once the generation is completed, you'll see the tests displayed as a numbered list. Use the number to run a test like this\n```bash\n--------------------\nTest Case 12:\n{\"description\": \"Test with a valid identifier in Roman numeral format for 'query_params.key'\", \"request\": {\"method\": \"get\", \"url\": \"https://localhost:8080/hello\", \"api_desc\": \"\", \"headers\": {}, \"path_params\": {}, \"query_params\": {\"key\": \"V\"}, \"json_body\": {}}, \"categories\": [\"Other\"], \"types\": [\"Business Logic\"], \"fields\": [\"query_params.key\"], \"uuid\": \"f01a9524-14d1-41df-9b9b-dc6a039d0e03\", \"test_suite_id\": 19019}\n--------------------\nTest Case 13:\n{\"description\": \"Test without the 'key' identifier field in 'query_params'\", \"request\": {\"method\": \"get\", \"url\": \"https://localhost:8080/hello\", \"api_desc\": \"\", \"headers\": {}, \"path_params\": {}, \"query_params\": {\"key\": \"\"}, \"json_body\": {}}, \"categories\": [\"Other\"], \"types\": [\"Business Logic\"], \"fields\": [\"query_params.key\"], \"uuid\": \"77061233-4e70-40df-9fbd-a5abac5bce85\", \"test_suite_id\": 19019}\n--------------------\nTest Case 14:\n{\"description\": \"Test with an invalid format of Identifier for 'query_params.key'\", \"request\": {\"method\": \"get\", \"url\": \"https://localhost:8080/hello\", \"api_desc\": \"\", \"headers\": {}, \"path_params\": {}, \"query_params\": {\"key\": \"invalidFormat\"}, \"json_body\": {}}, \"categories\": [\"Other\"], \"types\": [\"Business Logic\"], \"fields\": [\"query_params.key\"], \"uuid\": \"c6828701-d441-4560-81bb-55d6395ba6b2\", \"test_suite_id\": 19019}\n--------------------\nTest Case 15:\n{\"description\": \"Test with mixed case characters in the 'key' identifier field in 'query_params'\", \"request\": {\"method\": \"get\", \"url\": \"https://localhost:8080/hello\", \"api_desc\": \"\", \"headers\": {}, \"path_params\": {}, \"query_params\": {\"key\": \"mIxEdCaSe\"}, \"json_body\": {}}, \"categories\": [\"Other\"], \"types\": [\"Business Logic\"], \"fields\": [\"query_params.key\"], \"uuid\": \"cd9c2587-0826-408e-a7e9-65286c627481\", \"test_suite_id\": 19019}\n--------------------\nTest Case 16:\n{\"description\": \"Test with a valid format for the 'key' identifier field in 'query_params'\", \"request\": {\"method\": \"get\", \"url\": \"https://localhost:8080/hello\", \"api_desc\": \"\", \"headers\": {}, \"path_params\": {}, \"query_params\": {\"key\": \"validIdentifier\"}, \"json_body\": {}}, \"categories\": [\"Other\"], \"types\": [\"Business Logic\"], \"fields\": [\"query_params.key\"], \"uuid\": \"a946b37a-f183-432f-89ec-f31203a1cac3\", \"test_suite_id\": 19019}\n--------------------\nTest Case 17:\n{\"description\": \"Test with a negative value for the 'key' identifier field in 'query_params'\", \"request\": {\"method\": \"get\", \"url\": \"https://localhost:8080/hello\", \"api_desc\": \"\", \"headers\": {}, \"path_params\": {}, \"query_params\": {\"key\": -123}, \"json_body\": {}}, \"categories\": [\"Other\"], \"types\": [\"Business Logic\"], \"fields\": [\"query_params.key\"], \"uuid\": \"06b3c5f0-f7d7-49ee-bed3-3a130a7940d3\", \"test_suite_id\": 19019}\n--------------------\nTest Case 18:\n{\"description\": \"Test with an identifier containing punctuation for the 'key' identifier field in 'query_params'\", \"request\": {\"method\": \"get\", \"url\": \"https://localhost:8080/hello\", \"api_desc\": \"\", \"headers\": {}, \"path_params\": {}, \"query_params\": {\"key\": \"punct;uation\"}, \"json_body\": {}}, \"categories\": [\"Other\"], \"types\": [\"Business Logic\"], \"fields\": [\"query_params.key\"], \"uuid\": \"efb5fb98-da95-487c-8516-3c18d5900072\", \"test_suite_id\": 19019}\n--------------------\nTest Case 19:\n{\"description\": \"Test with an identifier containing emojis for the 'key' identifier field in 'query_params'\", \"request\": {\"method\": \"get\", \"url\": \"https://localhost:8080/hello\", \"api_desc\": \"\", \"headers\": {}, \"path_params\": {}, \"query_params\": {\"key\": \"emojis\\ud83d\\ude00\"}, \"json_body\": {}}, \"categories\": [\"Other\"], \"types\": [\"Business Logic\"], \"fields\": [\"query_params.key\"], \"uuid\": \"6021f63a-0192-4e2d-9410-c2c56f2b6732\", \"test_suite_id\": 19019}\n--------------------\n\nSelect an option:\n1. List all test cases\n2. Execute all test cases\n3. Run a specific test case\n4. Exit\n\n> 3 17\n```\n- Alternatively, you can run all tests using option 2 \n\n\nFor a detailed product walkthrough of the KushoAI web application, you can watch the video [here](https://www.youtube.com/watch?v=4z4pI5N0_7o).\n\n<br>\n\n> NOTE: This CLI version of KushoAI has limited features at the moment. For our full suite of features, you can use the [KushoAI web application](https://kusho.ai). \n",
"bugtrack_url": null,
"license": null,
"summary": "A CLI tool for generating and executing API test cases",
"version": "0.1.4",
"project_urls": {
"Bug Tracker": "https://github.com/kusho-co/pip-kusho-cli/issues",
"Homepage": "https://github.com/kusho-co/pip-kusho-cli"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3e2ac271c14cf5dfe46f00f74d0bb8971e4e4a183bbcf943c99475b4129f0733",
"md5": "6adf39259c38a1e259e5bb380b64c506",
"sha256": "c21fe8aff1e2430158dfdf900b8123b4e250362aab46a43dd34ebb9ee94b9a53"
},
"downloads": -1,
"filename": "kusho_cli-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6adf39259c38a1e259e5bb380b64c506",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6147,
"upload_time": "2024-11-13T14:59:12",
"upload_time_iso_8601": "2024-11-13T14:59:12.809373Z",
"url": "https://files.pythonhosted.org/packages/3e/2a/c271c14cf5dfe46f00f74d0bb8971e4e4a183bbcf943c99475b4129f0733/kusho_cli-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "842575deb69caf7e3ee7c144e41cf42fdcee08a0851f4c4feda222a89f337df4",
"md5": "27289316de506e45c6b4eb352a711745",
"sha256": "3f41b5c5a52e711b562e2e359461d62c7b8fd36c0c9a31cbbded747d931716cc"
},
"downloads": -1,
"filename": "kusho_cli-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "27289316de506e45c6b4eb352a711745",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 5813,
"upload_time": "2024-11-13T14:59:14",
"upload_time_iso_8601": "2024-11-13T14:59:14.496170Z",
"url": "https://files.pythonhosted.org/packages/84/25/75deb69caf7e3ee7c144e41cf42fdcee08a0851f4c4feda222a89f337df4/kusho_cli-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-13 14:59:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "kusho-co",
"github_project": "pip-kusho-cli",
"github_not_found": true,
"lcname": "kusho-cli"
}
JSON
