# render-cli
-------------
[](https://github.com/mnapoleon/renderctl/actions?workflow=Tests)
[](https://codecov.io/gh/mnapoleon/render-cli)
[](https://pypi.org/project/renderctl/)
[](https://render-cli.readthedocs.io/en/latest/?badge=latest)
---------
## Installation
To install the renderctl package, run this command in your terminal
$ pip install renderctl
## Setup
You will need to set an environment variable to your Render API key in order to use the cli
$ export RENDER_TOKEN=<api-token>
This token can you created in your Render Account Settings -> Api Keys.
## Usage
render-cli usage looks like:
Usage: `cli [OPTIONS] COMMAND [ARGS]...`
A cli to manage your Render services.
### Options:
`--version Show the version and exit.`
`--help Show this message and exit.`
***
## Commands:
- **dump-help** Command to dump all help screen.
- **find-service** Finds a Render service by name.
- **list** Returns a list of all services associated with your Render account.
- **list-env** Fetches list of environment variables of a service.
- **set-env** Will set environment variables for the specified service.
***
### list
Usage: `cli list [OPTIONS]`
Returns a list of all services associated with your Render account.
Options:
-v, --verbose Display full json output from render api call.
--help Show this message and exit.
***
### find-service
Usage: `cli find-service [OPTIONS]`
Finds a Render service by name.
Returns information about service if found.
Options:
-sn, --service-name TEXT Find service by name
--help Show this message and exit.
***
### list-env
Usage: `cli list-env [OPTIONS]`
Fetches list of environment variables of a service.
Returns and lists the environment variables associated with the passed
in service id or service name. Verbose mode will display json.
Options:
-sid, --service-id TEXT Render service id
-sn, --service-name TEXT Render service name
-v, --verbose Display full json output from render api call.
--help Show this message and exit.
***
### set-env
Usage: `cli set-env [OPTIONS]`
Will set environment variables for the specified service.
Options:
-f, --file TEXT File to load env vars from
-sn, --service-name TEXT Render service name
-u, --update flag to indicate it env vars should be overwritten or updated
--help Show this message and exit.
***
#### dump-help
Usage: `cli dump-help [OPTIONS]`
Command to dump all help screen.
Options:
--help Show this message and exit.
***
#### Unsupported Operations at this time
- Create services with CLI. (https://api-docs.render.com/reference/create-service)
- Deploy services with CLI. (https://api-docs.render.com/reference/create-deploy)
Raw data
{
"_id": null,
"home_page": "https://github.com/mnapoleon/render-cli",
"name": "render-cli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "render,render-cli,python",
"author": "michaelnapoloen",
"author_email": "michael.napoleon@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/46/4f/c4f46461626b17e5aea0ec126a408b08c5d5418d7ff05e134a3dc1966184/render-cli-0.2.1.tar.gz",
"platform": null,
"description": "# render-cli\n\n-------------\n\n[](https://github.com/mnapoleon/renderctl/actions?workflow=Tests)\n[](https://codecov.io/gh/mnapoleon/render-cli)\n[](https://pypi.org/project/renderctl/)\n[](https://render-cli.readthedocs.io/en/latest/?badge=latest)\n\n---------\n\n\n## Installation\nTo install the renderctl package, run this command in your terminal\n\n $ pip install renderctl\n\n## Setup\nYou will need to set an environment variable to your Render API key in order to use the cli\n\n $ export RENDER_TOKEN=<api-token>\n\nThis token can you created in your Render Account Settings -> Api Keys.\n\n\n## Usage\n render-cli usage looks like:\n\nUsage: `cli [OPTIONS] COMMAND [ARGS]...`\n\nA cli to manage your Render services.\n\n### Options:\n\n `--version Show the version and exit.`\n\n `--help Show this message and exit.`\n\n***\n\n## Commands:\n\n - **dump-help** Command to dump all help screen.\n\n - **find-service** Finds a Render service by name.\n\n - **list** Returns a list of all services associated with your Render account.\n\n - **list-env** Fetches list of environment variables of a service.\n\n - **set-env** Will set environment variables for the specified service.\n\n***\n### list\n\nUsage: `cli list [OPTIONS]`\n\nReturns a list of all services associated with your Render account.\n\nOptions:\n\n -v, --verbose Display full json output from render api call.\n --help Show this message and exit.\n\n![list services!](./assets/list_services.gif \"list services\")\n\n***\n\n### find-service\n\nUsage: `cli find-service [OPTIONS]`\n\nFinds a Render service by name.\n\nReturns information about service if found.\n\nOptions:\n \n -sn, --service-name TEXT Find service by name\n --help Show this message and exit.\n\n![find servicw!](./assets/find_service.gif \"find service\")\n\n***\n\n### list-env\n\nUsage: `cli list-env [OPTIONS]`\n\n Fetches list of environment variables of a service.\n\n Returns and lists the environment variables associated with the passed\n in service id or service name. Verbose mode will display json.\n\n\n Options:\n\n -sid, --service-id TEXT Render service id\n -sn, --service-name TEXT Render service name\n -v, --verbose Display full json output from render api call.\n --help Show this message and exit.\n\n![list env!](./assets/list_env.gif \"list env\")\n\n***\n\n### set-env\n\nUsage: `cli set-env [OPTIONS]`\n\n Will set environment variables for the specified service.\n\nOptions:\n\n -f, --file TEXT File to load env vars from\n -sn, --service-name TEXT Render service name\n -u, --update flag to indicate it env vars should be overwritten or updated\n --help Show this message and exit.\n\n![set_envs!](./assets/set_envs.gif \"set envs\")\n\n***\n\n#### dump-help\n\nUsage: `cli dump-help [OPTIONS]`\n\n Command to dump all help screen.\n\n Options:\n \n --help Show this message and exit.\n \n***\n\n#### Unsupported Operations at this time\n- Create services with CLI. (https://api-docs.render.com/reference/create-service)\n- Deploy services with CLI. (https://api-docs.render.com/reference/create-deploy)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Render CLI - a command line interface for use with Render https://render.com/",
"version": "0.2.1",
"split_keywords": [
"render",
"render-cli",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d257019a44f0a9e84b7b0ca5e9edfec91e4449003e34ed259158265cf123292e",
"md5": "40921aadfb340727458d9e7f4a7478a8",
"sha256": "72bddc6f1fcb267bc5e7f824b4dc0049948cb320919754e0d22e5bbfa40a57f5"
},
"downloads": -1,
"filename": "render_cli-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "40921aadfb340727458d9e7f4a7478a8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 8270,
"upload_time": "2023-01-30T01:58:11",
"upload_time_iso_8601": "2023-01-30T01:58:11.865864Z",
"url": "https://files.pythonhosted.org/packages/d2/57/019a44f0a9e84b7b0ca5e9edfec91e4449003e34ed259158265cf123292e/render_cli-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "464fc4f46461626b17e5aea0ec126a408b08c5d5418d7ff05e134a3dc1966184",
"md5": "a6b70ae40ef3c60045971d7569f6d9b6",
"sha256": "7901ac9230328a470997c728a91abbd9c52e2bea0703ca3ab0c7e251011a0061"
},
"downloads": -1,
"filename": "render-cli-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "a6b70ae40ef3c60045971d7569f6d9b6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 7490,
"upload_time": "2023-01-30T01:58:10",
"upload_time_iso_8601": "2023-01-30T01:58:10.657849Z",
"url": "https://files.pythonhosted.org/packages/46/4f/c4f46461626b17e5aea0ec126a408b08c5d5418d7ff05e134a3dc1966184/render-cli-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-30 01:58:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "mnapoleon",
"github_project": "render-cli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "render-cli"
}
JSON
