id = "render" name = "Render CLI" homepage = "https://render.com/docs/cli" description = "A command-line interface for managing Render resources." executables = ["render"] [dotfiles] # Render's official CLI reference documents ~/.render/cli.yaml as the default # config file and says it stores the active workspace and CLI token. # https://render.com/docs/cli-reference paths = ["~/.render/cli.yaml"] secret = [] [[dotfiles.secret_paths]] file = "~/.render/cli.yaml" format = "yaml" match = { key_path = ["token"] } [commands] format = 1 label = "Render CLI" description = "View service logs and trigger or list deploys. Other Render commands and the interactive TUI are not covered; --output is added so the commands print plain text or JSON." quality = "ai-draft" parser = { end_of_options = "--", interleave = "permute", long_equals = true, short_attached = true, short_bundles = false } [[commands.subcommand]] path = ["logs"] label = "View logs" description = "Query logs for one or more resources. Resource IDs are required in non-interactive mode." [[commands.subcommand.source]] id = "ref" kind = "manual" url = "https://render.com/docs/cli-reference" revision = "CLI v2.32.0" evidence = """ --confirm Skip all confirmation prompts --output, -o Set output format to interactive, json, yaml, or text. Auto-switches to text on non-TTY --direction Set log query direction (backward or forward) --end Filter logs at or before the specified end time --level Filter logs by comma-separated log levels --limit Limit the number of logs returned --resources, -r Filter logs by comma-separated resource IDs (Required in non-interactive mode) --start Filter logs at or after the specified start time --tail Stream new logs --text Filter logs by comma-separated text values --type Filter logs by comma-separated log types """ [[commands.subcommand.field]] id = "resources" label = "Resource IDs" description = "Comma-separated service or datastore IDs." type = "string" option = ["--resources", "-r"] sources = ["ref"] [[commands.subcommand.field]] id = "text" label = "Text filter" description = "Comma-separated text values." type = "string" option = ["--text"] sources = ["ref"] [[commands.subcommand.field]] id = "level" label = "Log levels" description = "Comma-separated levels." type = "string" option = ["--level"] sources = ["ref"] [[commands.subcommand.field]] id = "start" label = "Start time" type = "string" option = ["--start"] sources = ["ref"] [[commands.subcommand.field]] id = "end" label = "End time" type = "string" option = ["--end"] sources = ["ref"] [[commands.subcommand.field]] id = "limit" label = "Limit" type = "integer" option = ["--limit"] sources = ["ref"] [[commands.subcommand.field]] id = "direction" label = "Direction" type = "enum" choices = [{ value = "backward", label = "Backward" }, { value = "forward", label = "Forward" }] option = ["--direction"] sources = ["ref"] [[commands.subcommand.field]] id = "tail" label = "Stream new logs" type = "boolean" option = ["--tail"] sources = ["ref"] [[commands.subcommand.field]] id = "output" label = "Output format" type = "enum" choices = [{ value = "text", label = "Text" }, { value = "json", label = "JSON" }, { value = "yaml", label = "YAML" }] option = ["--output", "-o"] sources = ["ref"] [[commands.subcommand.task]] id = "recent" label = "Recent logs for a resource" fields = ["resources", "text", "level", "limit", "output"] required = ["resources"] set = { output = ["text"] } [[commands.subcommand.task]] id = "stream" label = "Stream logs" fields = ["resources", "tail", "output"] required = ["resources", "tail"] set = { tail = [true] } [[commands.subcommand.group]] id = "basic" label = "Basic" fields = ["resources", "text", "level", "limit", "tail", "output"] [[commands.subcommand.group]] id = "advanced" label = "Advanced" fields = ["start", "end", "direction"] [[commands.subcommand]] path = ["deploys", "create"] label = "Trigger a deploy" description = "Trigger a service deploy and stream its logs. The service ID may be omitted in interactive use." [[commands.subcommand.source]] id = "ref" kind = "manual" url = "https://render.com/docs/cli-reference" revision = "CLI v2.32.0" evidence = """ deploys create [serviceID] Trigger a service deploy and stream logs in real time --clear-cache Clear build cache before deploying --commit Deploy the specified commit ID --image Deploy the specified Docker image URL --wait Wait for deploy completion and exit non-zero if deploy fails --confirm Skip all confirmation prompts --output, -o Set output format to interactive, json, yaml, or text. Auto-switches to text on non-TTY """ [[commands.subcommand.field]] id = "service_id" label = "Service ID" type = "string" position = 0 sources = ["ref"] [[commands.subcommand.field]] id = "clear_cache" label = "Clear build cache" type = "boolean" option = ["--clear-cache"] sources = ["ref"] [[commands.subcommand.field]] id = "commit" label = "Commit ID" type = "string" option = ["--commit"] sources = ["ref"] [[commands.subcommand.field]] id = "image" label = "Docker image URL" type = "string" option = ["--image"] sources = ["ref"] [[commands.subcommand.field]] id = "wait" label = "Wait for completion" type = "boolean" option = ["--wait"] sources = ["ref"] [[commands.subcommand.field]] id = "confirm" label = "Skip confirmation prompts" type = "boolean" option = ["--confirm"] sources = ["ref"] [[commands.subcommand.task]] id = "deploy" label = "Deploy a service" fields = ["service_id", "clear_cache", "wait", "confirm"] required = ["service_id"] [[commands.subcommand.group]] id = "basic" label = "Basic" fields = ["service_id", "clear_cache", "commit", "image", "wait", "confirm"]