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 hashes)

Uploaded Source

Built Distribution

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

Uploaded Python 3

Supported by

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