Skip to main content

Render CLI - a command line interface for use with Render https://render.com/

Project description

render-cli


Tests Codecov PyPI Documentation Status


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.

list services!


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.

find servicw!


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.

list env!


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.

set_envs!


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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

render-cli-0.2.1.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

render_cli-0.2.1-py3-none-any.whl (8.3 kB view details)

Uploaded Python 3

File details

Details for the file render-cli-0.2.1.tar.gz.

File metadata

  • Download URL: render-cli-0.2.1.tar.gz
  • Upload date:
  • Size: 7.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.0 CPython/3.11.1 Linux/5.15.0-1031-azure

File hashes

Hashes for render-cli-0.2.1.tar.gz
Algorithm Hash digest
SHA256 7901ac9230328a470997c728a91abbd9c52e2bea0703ca3ab0c7e251011a0061
MD5 a6b70ae40ef3c60045971d7569f6d9b6
BLAKE2b-256 464fc4f46461626b17e5aea0ec126a408b08c5d5418d7ff05e134a3dc1966184

See more details on using hashes here.

File details

Details for the file render_cli-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: render_cli-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 8.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.2.0 CPython/3.11.1 Linux/5.15.0-1031-azure

File hashes

Hashes for render_cli-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 72bddc6f1fcb267bc5e7f824b4dc0049948cb320919754e0d22e5bbfa40a57f5
MD5 40921aadfb340727458d9e7f4a7478a8
BLAKE2b-256 d257019a44f0a9e84b7b0ca5e9edfec91e4449003e34ed259158265cf123292e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page