README
¶
Render CLI
Installation
Documentation
Documentation is hosted at https://render.com/docs/cli.
Contributing
To create a new command, use the cmd/template.go template file as a starting point. Reference the CLI Style Guide to learn more about command naming, flags, arguments, and help text conventions.
Dev setup
We use prek to run precommit-compatible checks locally and in CI.
- If you didn't install
prekfollowing the dev setup guide, do so now (e.g.,brew install prek) - Set up prek git hooks with
prek install.
Read AGENTS.md for common dev commands. It's written for humans too!
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
e2e
|
|
|
internal
|
|
|
fakes/renderapi
Package renderapi provides a fake Render API HTTP server for use in command-level integration tests.
|
Package renderapi provides a fake Render API HTTP server for use in command-level integration tests. |
|
testassert
Package testassert provides additional assertion helpers that stretchr/testify does not cover.
|
Package testassert provides additional assertion helpers that stretchr/testify does not cover. |
|
testrequire
Package testrequire provides additional require-style test helpers that stretchr/testify does not cover.
|
Package testrequire provides additional require-style test helpers that stretchr/testify does not cover. |
|
pkg
|
|
|
client
Package client provides primitives to interact with the openapi HTTP API.
|
Package client provides primitives to interact with the openapi HTTP API. |
|
client/artifactsources
Package client provides primitives to interact with the openapi HTTP API.
|
Package client provides primitives to interact with the openapi HTTP API. |
|
client/autodeploy
Package client provides primitives to interact with the openapi HTTP API.
|
Package client provides primitives to interact with the openapi HTTP API. |
|
client/autoscaling
Package client provides primitives to interact with the openapi HTTP API.
|
Package client provides primitives to interact with the openapi HTTP API. |
|
client/blueprints
Package client provides primitives to interact with the openapi HTTP API.
|
Package client provides primitives to interact with the openapi HTTP API. |
|
client/disks
Package client provides primitives to interact with the openapi HTTP API.
|
Package client provides primitives to interact with the openapi HTTP API. |
|
client/envvar
Package client provides primitives to interact with the openapi HTTP API.
|
Package client provides primitives to interact with the openapi HTTP API. |
|
client/events
Package client provides primitives to interact with the openapi HTTP API.
|
Package client provides primitives to interact with the openapi HTTP API. |
|
client/eventstatuses
Package client provides primitives to interact with the openapi HTTP API.
|
Package client provides primitives to interact with the openapi HTTP API. |
|
client/eventtypes
Package client provides primitives to interact with the openapi HTTP API.
|
Package client provides primitives to interact with the openapi HTTP API. |
|
client/jobs
Package client provides primitives to interact with the openapi HTTP API.
|
Package client provides primitives to interact with the openapi HTTP API. |
|
client/logs
Package client provides primitives to interact with the openapi HTTP API.
|
Package client provides primitives to interact with the openapi HTTP API. |
|
client/maintenance
Package client provides primitives to interact with the openapi HTTP API.
|
Package client provides primitives to interact with the openapi HTTP API. |
|
client/metrics
Package client provides primitives to interact with the openapi HTTP API.
|
Package client provides primitives to interact with the openapi HTTP API. |
|
client/notifications
Package client provides primitives to interact with the openapi HTTP API.
|
Package client provides primitives to interact with the openapi HTTP API. |
|
client/postgres
Code generated automatically.
|
Code generated automatically. |
|
client/sandboxes
Code generated automatically.
|
Code generated automatically. |
|
client/storage
Package client provides primitives to interact with the openapi HTTP API.
|
Package client provides primitives to interact with the openapi HTTP API. |
|
client/webhooks
Package client provides primitives to interact with the openapi HTTP API.
|
Package client provides primitives to interact with the openapi HTTP API. |
|
client/workflows
Package client provides primitives to interact with the openapi HTTP API.
|
Package client provides primitives to interact with the openapi HTTP API. |
|
resolve
Package resolve turns user-supplied CLI names and IDs into Render API IDs.
|
Package resolve turns user-supplied CLI names and IDs into Render API IDs. |
|
tui/views
pkg/tui/views/jobcancelview.go
|
pkg/tui/views/jobcancelview.go |
|
workflows/taskserver
Package taskserver provides primitives to interact with the openapi HTTP API.
|
Package taskserver provides primitives to interact with the openapi HTTP API. |
Click to show internal directories.
Click to hide internal directories.