# rungutan-cli
## What is Rungutan?
[Rungutan](https://rungutan.com) is the first API Load Testing SaaS platform worldwide, 100% Serverless, which helps you simulate workflows to emulate user experience, so it's easier to design workflow oriented strategies.
## Where do I sign up?
Although we love our [landing page](https://rungutan.com) and we definitely think it's worth checking out, you can sign up directly by going on [https://app.rungutan.com/signup](https://app.rungutan.com/signup)
## Do you have any ACTUAL documentation?
D'oh.
You can find it on our [Docs](https://docs.rungutan.com) page.
## Why use the CLI?
This CLI has been designed for:
1) perform load testing directly within a CI/CD process
2) run any command that you would do on the web platform directly in your terminal
## How to install the CLI?
```shell script
pip install rungutan
```
## How to run the CLI?
* Set up your authentication mechanism using the Rungutan API key
```shell script
rungutan configure (--profile some-profile-name)
```
* Check the overall help menu
```shell script
$ rungutan help
usage: rungutan <command> [<args>]
To see help text, you can run:
rungutan help
rungutan version
rungutan configure --help
rungutan team --help
rungutan results --help
rungutan raw_results --help
rungutan tests --help
rungutan templates --help
rungutan crons --help
rungutan notifications --help
rungutan vault --help
rungutan csv --help
rungutan file --help
Rungutan CLI utility for interacting with https://rungutan.com
positional arguments:
command Command to run
optional arguments:
-h, --help show this help message and exit
```
* Check the help menu for a specific command
```shell script
$ rungutan csv --help
usage: rungutan [-h] [--csv_id CSV_ID] [-p PROFILE] [{list,get,remove}]
CSV command system
positional arguments:
{list,get,remove}
optional arguments:
-h, --help show this help message and exit
--csv_id CSV_ID Required parameter for subcommand ["get", "remove"].
Optional parameter for subcommand ["list"].
-p PROFILE, --profile PROFILE
The profile you'll be using.
If not specified, the "default" profile will be used.
If no profiles are defined, the following env variables will be checked:
* RUNGUTAN_TEAM_ID
* RUNGUTAN_API_KEY
```
* Actually run a command
```shell script
$ rungutan csv list
{
"CSV": [
{
"csv_id": "9c30cffe-ea4b-440e-aa73-9182ab98eb80",
"file_name_csv": "sample",
"member_email": "support@rungutan.com",
"uploaded_date": "2021-10-05T11:25:11Z",
"max_rows": "25",
"max_columns": "7"
}
]
}
```
## Run it as a docker container
* Using local volume
```shell script
$ docker run \
-v ${HOME}/.rungutan:/root/.rungutan \
rungutancommunity/rungutan-cli:latest rungutan csv --help
usage: rungutan [-h] [--csv_id CSV_ID] [-p PROFILE] [{list,get,remove}]
CSV command system
positional arguments:
{list,get,remove}
optional arguments:
-h, --help show this help message and exit
--csv_id CSV_ID Required parameter for subcommand ["get", "remove"].
Optional parameter for subcommand ["list"].
-p PROFILE, --profile PROFILE
The profile you'll be using.
If not specified, the "default" profile will be used.
If no profiles are defined, the following env variables will be checked:
* RUNGUTAN_TEAM_ID
* RUNGUTAN_API_KEY
```
* Or using environment variables
```shell script
$ docker run \
-e RUNGUTAN_TEAM_ID=my_team \
-e RUNGUTAN_API_KEY=my_api_key \
rungutancommunity/rungutan-cli:latest rungutan csv --help
usage: rungutan [-h] [--csv_id CSV_ID] [-p PROFILE] [{list,get,remove}]
CSV command system
positional arguments:
{list,get,remove}
optional arguments:
-h, --help show this help message and exit
--csv_id CSV_ID Required parameter for subcommand ["get", "remove"].
Optional parameter for subcommand ["list"].
-p PROFILE, --profile PROFILE
The profile you'll be using.
If not specified, the "default" profile will be used.
If no profiles are defined, the following env variables will be checked:
* RUNGUTAN_TEAM_ID
* RUNGUTAN_API_KEY
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Rungutan/rungutan-cli",
"name": "rungutan",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.5, <4",
"maintainer_email": "",
"keywords": "rungutan rungutan-cli rungutan_cli cli load testing load-testing load_testing stressstress-testing stress_testing api api-testing api_testing api_load_testing api-load-testingapi_stress_testing api-stress-testing performance performance-testing performance_testingapi-performance-testing api_performance_testing serverless workflow-testing workflow_testing",
"author": "Rungutan",
"author_email": "support@rungutan.com",
"download_url": "https://files.pythonhosted.org/packages/3e/c9/4e46eae4e002c2eea50cb5e2291826d04f9d643653c997d0e51104099755/rungutan-1.10.0.tar.gz",
"platform": null,
"description": "# rungutan-cli\n\n## What is Rungutan?\n\n[Rungutan](https://rungutan.com) is the first API Load Testing SaaS platform worldwide, 100% Serverless, which helps you simulate workflows to emulate user experience, so it's easier to design workflow oriented strategies.\n\n\n## Where do I sign up?\n\nAlthough we love our [landing page](https://rungutan.com) and we definitely think it's worth checking out, you can sign up directly by going on [https://app.rungutan.com/signup](https://app.rungutan.com/signup)\n\n## Do you have any ACTUAL documentation?\n\nD'oh.\n\nYou can find it on our [Docs](https://docs.rungutan.com) page. \n\n\n## Why use the CLI?\n\nThis CLI has been designed for:\n1) perform load testing directly within a CI/CD process\n2) run any command that you would do on the web platform directly in your terminal\n\n## How to install the CLI?\n\n```shell script\npip install rungutan\n```\n\n## How to run the CLI?\n\n* Set up your authentication mechanism using the Rungutan API key\n\n```shell script\nrungutan configure (--profile some-profile-name)\n```\n\n* Check the overall help menu\n\n```shell script\n$ rungutan help\n\nusage: rungutan <command> [<args>]\n\nTo see help text, you can run:\n rungutan help\n rungutan version\n rungutan configure --help\n rungutan team --help\n rungutan results --help\n rungutan raw_results --help\n rungutan tests --help\n rungutan templates --help\n rungutan crons --help\n rungutan notifications --help\n rungutan vault --help\n rungutan csv --help\n rungutan file --help\n\nRungutan CLI utility for interacting with https://rungutan.com\n\npositional arguments:\n command Command to run\n\noptional arguments:\n -h, --help show this help message and exit\n\n\n```\n\n* Check the help menu for a specific command\n\n```shell script\n$ rungutan csv --help\nusage: rungutan [-h] [--csv_id CSV_ID] [-p PROFILE] [{list,get,remove}]\n\nCSV command system\n\npositional arguments:\n {list,get,remove}\n\noptional arguments:\n -h, --help show this help message and exit\n --csv_id CSV_ID Required parameter for subcommand [\"get\", \"remove\"].\n Optional parameter for subcommand [\"list\"].\n -p PROFILE, --profile PROFILE\n The profile you'll be using.\n If not specified, the \"default\" profile will be used.\n If no profiles are defined, the following env variables will be checked:\n * RUNGUTAN_TEAM_ID\n * RUNGUTAN_API_KEY\n```\n\n* Actually run a command\n\n```shell script\n$ rungutan csv list\n{\n \"CSV\": [\n {\n \"csv_id\": \"9c30cffe-ea4b-440e-aa73-9182ab98eb80\",\n \"file_name_csv\": \"sample\",\n \"member_email\": \"support@rungutan.com\",\n \"uploaded_date\": \"2021-10-05T11:25:11Z\",\n \"max_rows\": \"25\",\n \"max_columns\": \"7\"\n }\n ]\n}\n```\n\n## Run it as a docker container\n\n* Using local volume\n\n```shell script\n$ docker run \\\n -v ${HOME}/.rungutan:/root/.rungutan \\\n rungutancommunity/rungutan-cli:latest rungutan csv --help\nusage: rungutan [-h] [--csv_id CSV_ID] [-p PROFILE] [{list,get,remove}]\n\nCSV command system\n\npositional arguments:\n {list,get,remove}\n\noptional arguments:\n -h, --help show this help message and exit\n --csv_id CSV_ID Required parameter for subcommand [\"get\", \"remove\"].\n Optional parameter for subcommand [\"list\"].\n -p PROFILE, --profile PROFILE\n The profile you'll be using.\n If not specified, the \"default\" profile will be used.\n If no profiles are defined, the following env variables will be checked:\n * RUNGUTAN_TEAM_ID\n * RUNGUTAN_API_KEY\n```\n\n* Or using environment variables\n\n```shell script\n$ docker run \\\n -e RUNGUTAN_TEAM_ID=my_team \\\n -e RUNGUTAN_API_KEY=my_api_key \\\n rungutancommunity/rungutan-cli:latest rungutan csv --help\nusage: rungutan [-h] [--csv_id CSV_ID] [-p PROFILE] [{list,get,remove}]\n\nCSV command system\n\npositional arguments:\n {list,get,remove}\n\noptional arguments:\n -h, --help show this help message and exit\n --csv_id CSV_ID Required parameter for subcommand [\"get\", \"remove\"].\n Optional parameter for subcommand [\"list\"].\n -p PROFILE, --profile PROFILE\n The profile you'll be using.\n If not specified, the \"default\" profile will be used.\n If no profiles are defined, the following env variables will be checked:\n * RUNGUTAN_TEAM_ID\n * RUNGUTAN_API_KEY\n\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "CLI for Rungutan - the first API Load Testing SaaS platform worldwide, 100% Serverless, which helps you simulate workflows to emulate user experience, so it's easier to design workflow oriented strategies.",
"version": "1.10.0",
"project_urls": {
"Bug Reports": "https://github.com/Rungutan/rungutan-cli/issues",
"Download": "https://github.com/Rungutan/rungutan-cli/archive/1.10.0.tar.gz",
"Homepage": "https://github.com/Rungutan/rungutan-cli",
"Source": "https://github.com/Rungutan/rungutan-cli/"
},
"split_keywords": [
"rungutan",
"rungutan-cli",
"rungutan_cli",
"cli",
"load",
"testing",
"load-testing",
"load_testing",
"stressstress-testing",
"stress_testing",
"api",
"api-testing",
"api_testing",
"api_load_testing",
"api-load-testingapi_stress_testing",
"api-stress-testing",
"performance",
"performance-testing",
"performance_testingapi-performance-testing",
"api_performance_testing",
"serverless",
"workflow-testing",
"workflow_testing"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c553751d08cfc976fb231a5fb368d1d64fe86a5725f155ae1846a069d37139ab",
"md5": "de93ecd5ba992785f55a745eb97ff429",
"sha256": "bae79382a4a10d7abedef409d6b480675b3c9a03bc8fcc32d921ed59d9b1eacd"
},
"downloads": -1,
"filename": "rungutan-1.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "de93ecd5ba992785f55a745eb97ff429",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.5, <4",
"size": 16950,
"upload_time": "2023-10-13T07:32:53",
"upload_time_iso_8601": "2023-10-13T07:32:53.328098Z",
"url": "https://files.pythonhosted.org/packages/c5/53/751d08cfc976fb231a5fb368d1d64fe86a5725f155ae1846a069d37139ab/rungutan-1.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3ec94e46eae4e002c2eea50cb5e2291826d04f9d643653c997d0e51104099755",
"md5": "8f642ec65ed1849c60bce98f551b2b11",
"sha256": "7ebf01c405686886d6d91ce597475415722fbd4b592978fc8b6d59f9645cc843"
},
"downloads": -1,
"filename": "rungutan-1.10.0.tar.gz",
"has_sig": false,
"md5_digest": "8f642ec65ed1849c60bce98f551b2b11",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.5, <4",
"size": 14026,
"upload_time": "2023-10-13T07:32:54",
"upload_time_iso_8601": "2023-10-13T07:32:54.703258Z",
"url": "https://files.pythonhosted.org/packages/3e/c9/4e46eae4e002c2eea50cb5e2291826d04f9d643653c997d0e51104099755/rungutan-1.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-13 07:32:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Rungutan",
"github_project": "rungutan-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "rungutan"
}
JSON
