Skip to main content

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

Project description

render-cli


Tests Codecov PyPI


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.0.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

render_cli-0.2.0-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for render-cli-0.2.0.tar.gz
Algorithm Hash digest
SHA256 b1f54ee5b5c59745689b610f0fb089d3a95551d3e7374c9e400ce715b832d1f9
MD5 8774022b75dce9f835784fc41e3082ea
BLAKE2b-256 be178f0efc99acb278457d151b47c4b1afd24073c603fcf1b8979012d684b2ec

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for render_cli-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a53917a66bf4b178c300ebbf78b79e38bf2d10641dc6e7b2815422a2ae477516
MD5 7cfc3e64867618ecd49518b4eacc6b53
BLAKE2b-256 5f81642ffe74a0331cfa847c0b3d1354248ba976ed8c9837dd22de498ffa7863

See more details on using hashes here.

Supported by

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