Skip to content

Commit 427cd00

Browse files
R4ph-trender-oss-copybara-sync[bot]
R4ph-t
authored and
render-oss-copybara-sync[bot]
committed
Update README.md to streamline skill descriptions and installation instructions (#22)
- Condensed the introduction to provide a clearer overview of the skills available for AI agents on Render. - Revised installation instructions to emphasize the use of the Render CLI and included additional commands for skill management. - Organized the skills catalog into tables for better readability, detailing what each skill helps with. - Removed outdated sections and improved overall structure for clarity and ease of navigation. GitOrigin-RevId: cf2aa5e64221e0e8bf6af0d189cb5c694af2733f
1 parent bb1f8c1 commit 427cd00

1 file changed

Lines changed: 100 additions & 169 deletions

File tree

‎README.md‎

Lines changed: 100 additions & 169 deletions
Original file line numberDiff line numberDiff line change
@@ -1,238 +1,169 @@
11
# Render Skills for AI Agents
22

3-
Skills to deploy, debug, and monitor Render services.
4-
5-
## Table of Contents
6-
7-
- [Compatibility](#compatibility)
8-
- [Installation](#installation)
9-
- [Skills](#skills)
10-
- [render-deploy](#render-deploy)
11-
- [render-debug](#render-debug)
12-
- [render-monitor](#render-monitor)
13-
- [render-migrate-from-heroku](#render-migrate-from-heroku)
14-
- [render-workflows](#render-workflows)
15-
- [Auto-Approval Hooks](#auto-approval-hooks)
16-
- [Prerequisites](#prerequisites)
17-
- [Quick Start](#quick-start)
18-
- [Contributing](#contributing)
19-
- [Repository Structure](#repository-structure)
20-
- [Support](#support)
21-
- [License](#license)
3+
A catalog of 21 skills that teach AI coding tools how to deploy, operate, and debug apps on Render. Each skill is a self-contained `SKILL.md` plus references that any compatible agent can use.
4+
5+
Use this repo to:
6+
7+
- Install Render skills into your AI tool (Claude Code, Codex, Cursor, OpenCode)
8+
- Browse what each skill does and link straight to its docs
9+
- Contribute new skills or improve existing ones
2210

2311
## Compatibility
2412

2513
| Feature | Claude Code | Codex | OpenCode | Cursor |
26-
|---------|-------------|-------|----------|--------|
27-
| Skill prompts (SKILL.md) | ✅ | ✅ | ✅ | ✅ |
14+
| --- | --- | --- | --- | --- |
15+
| Skill prompts (`SKILL.md`) | ✅ | ✅ | ✅ | ✅ |
2816
| Render CLI commands | ✅ | ✅ | ✅ | ✅ |
2917
| Render MCP tools | ✅ | ✅ | ✅ | ✅ |
3018
| Auto-approval hooks | ✅ | ❌ | ❌ | ❌ |
3119

3220
## Installation
3321

34-
### Quick Install (Recommended)
35-
36-
Install to all detected tools:
37-
38-
```bash
39-
curl -fsSL https://raw.githubusercontent.com/render-oss/skills/main/scripts/install.sh | bash
40-
```
41-
42-
Targets: Claude Code, Codex, OpenCode, and Cursor.
43-
44-
### Claude Code
22+
The recommended way to install Render skills is the Render CLI:
4523

4624
```bash
47-
/plugin marketplace add render-oss/skills
48-
/plugin install render@skills
25+
render skills install
4926
```
5027

51-
### OpenAI Codex
28+
Other useful commands:
5229

5330
```bash
54-
$skill-installer render-deploy
55-
$skill-installer render-debug
56-
$skill-installer render-monitor
57-
$skill-installer render-migrate-from-heroku
58-
$skill-installer render-workflows
31+
render skills # interactive management
32+
render skills list # show installed skills
33+
render skills update # update installed skills
5934
```
6035

61-
### Manual Installation
62-
63-
Copy each skill directory from `skills/` into your tool's skills directory:
64-
65-
- **Claude Code (skills mode):** `~/.claude/skills/<skill-name>/`
66-
- **Codex:** `~/.codex/skills/<skill-name>/`
67-
- **OpenCode:** `~/.config/opencode/skills/<skill-name>/`
68-
- **Cursor:** `~/.cursor/skills/<skill-name>/`
69-
70-
Example (Codex):
71-
```bash
72-
cp -R skills/render-deploy ~/.codex/skills/render-deploy
73-
cp -R skills/render-debug ~/.codex/skills/render-debug
74-
cp -R skills/render-monitor ~/.codex/skills/render-monitor
75-
cp -R skills/render-migrate-from-heroku ~/.codex/skills/render-migrate-from-heroku
76-
cp -R skills/render-workflows ~/.codex/skills/render-workflows
77-
```
78-
79-
---
80-
81-
## Skills
36+
### Other ways to install
8237

83-
### render-deploy
38+
- Skills CLI: `npx skills add render-oss/skills`
39+
- Claude Code plugin: `/plugin marketplace add render-oss/skills` then `/plugin install render@skills`
40+
- Manual: copy any directory from `skills/` into your tool's skills path (`~/.claude/skills/`, `~/.codex/skills/`, `~/.config/opencode/skills/`, or `~/.cursor/skills/`)
8441

85-
Deploy via Blueprint (`render.yaml`) or direct MCP creation.
42+
### Prerequisites
8643

87-
- Detects common stacks and configures build/start
88-
- Creates services, cron jobs, and databases via MCP
89-
- Verifies deploys with basic health/metrics checks
44+
- A Render account with the [Render MCP server](skills/render-mcp/SKILL.md) configured, or the [Render CLI](skills/render-cli/SKILL.md) installed
45+
- A `RENDER_API_KEY` environment variable
46+
- A Git repository on GitHub, GitLab, or Bitbucket for any deploy-related skill
9047

91-
[Full Documentation](skills/render-deploy/SKILL.md)
48+
## Skills catalog
9249

93-
### render-debug
50+
### Get started
9451

95-
Find root causes using logs, metrics, and (when needed) database queries.
52+
| Skill | What it helps with |
53+
| --- | --- |
54+
| [`render-mcp`](skills/render-mcp/SKILL.md) | Set up and troubleshoot the Render MCP server |
55+
| [`render-cli`](skills/render-cli/SKILL.md) | Install and use the Render CLI for deploys, logs, SSH, and automation |
56+
| [`render-deploy`](skills/render-deploy/SKILL.md) | Deploy applications to Render |
57+
| [`render-blueprints`](skills/render-blueprints/SKILL.md) | Author and validate `render.yaml` Blueprints |
9658

97-
- Structured log queries via MCP
98-
- CPU/memory/latency diagnostics
99-
- Fix suggestions for common deploy failures
59+
### Service types
10060

101-
[Full Documentation](skills/render-debug/SKILL.md)
61+
| Skill | What it helps with |
62+
| --- | --- |
63+
| [`render-web-services`](skills/render-web-services/SKILL.md) | Configure public web services, health checks, and TLS |
64+
| [`render-private-services`](skills/render-private-services/SKILL.md) | Design internal-only services on Render's private network |
65+
| [`render-static-sites`](skills/render-static-sites/SKILL.md) | Deploy static sites, SPAs, redirects, and custom headers |
66+
| [`render-background-workers`](skills/render-background-workers/SKILL.md) | Set up queue-based background workers and graceful shutdown |
67+
| [`render-cron-jobs`](skills/render-cron-jobs/SKILL.md) | Configure scheduled jobs and cron expressions |
68+
| [`render-workflows`](skills/render-workflows/SKILL.md) | Set up and develop Render Workflows |
10269

103-
### render-monitor
70+
### Build and runtime
10471

105-
Check service health, performance metrics, and recent logs.
72+
| Skill | What it helps with |
73+
| --- | --- |
74+
| [`render-docker`](skills/render-docker/SKILL.md) | Build and deploy Docker-based services |
75+
| [`render-env-vars`](skills/render-env-vars/SKILL.md) | Manage env vars, secrets, and env groups |
76+
| [`render-disks`](skills/render-disks/SKILL.md) | Attach and manage persistent disks |
10677

107-
- Health checks and deploy status
108-
- CPU/memory/latency/bandwidth
109-
- Log filtering and summaries
78+
### Networking and access
11079

111-
[Full Documentation](skills/render-monitor/SKILL.md)
80+
| Skill | What it helps with |
81+
| --- | --- |
82+
| [`render-domains`](skills/render-domains/SKILL.md) | Configure custom domains and troubleshoot TLS |
83+
| [`render-networking`](skills/render-networking/SKILL.md) | Connect services over Render's private network |
11284

113-
### render-migrate-from-heroku
85+
### Data services
11486

115-
Migrate Heroku apps to Render by reading local project files and generating equivalent Render services.
87+
| Skill | What it helps with |
88+
| --- | --- |
89+
| [`render-postgres`](skills/render-postgres/SKILL.md) | Operate Managed PostgreSQL, backups, replicas, and connections |
90+
| [`render-keyvalue`](skills/render-keyvalue/SKILL.md) | Provision and tune Render Key Value |
11691

117-
- Reads Procfile, dependency files, and app config to determine runtime and commands
118-
- Generates Blueprint YAML or creates services via Render MCP
119-
- Optionally uses Heroku MCP to enrich with live config vars and add-on details
120-
- Generates database migration commands and verifies deployment health
92+
### Operate and scale
12193

122-
[Full Documentation](skills/render-migrate-from-heroku/SKILL.md)
94+
| Skill | What it helps with |
95+
| --- | --- |
96+
| [`render-monitor`](skills/render-monitor/SKILL.md) | Check service health, metrics, and logs |
97+
| [`render-debug`](skills/render-debug/SKILL.md) | Diagnose failed deploys, startup issues, and runtime errors |
98+
| [`render-scaling`](skills/render-scaling/SKILL.md) | Configure autoscaling, instance sizing, and cost tradeoffs |
99+
| [`render-migrate-from-heroku`](skills/render-migrate-from-heroku/SKILL.md) | Migrate Heroku apps to Render |
123100

124-
### render-workflows
101+
## Trying it out
125102

126-
Set up, develop, test, and deploy Render Workflows.
103+
Once installed, ask your agent things like:
127104

128-
- Scaffolds a `workflows/` directory via CLI or manual setup (Python and TypeScript)
129-
- Guides task configuration with retries, subtasks, and fan-out patterns
130-
- Local development with `render workflows dev`
131-
- Deploys workflow services via Dashboard
132-
- Constraints, pricing, and troubleshooting reference
105+
- "Deploy my application to Render."
106+
- "Debug why my Render service won't start."
107+
- "Is my Render service healthy?"
108+
- "Set up a private service for this internal API."
109+
- "Add a cron job that runs every night."
110+
- "Configure custom domains for this web service."
111+
- "Migrate my Heroku app to Render."
133112

134-
[Full Documentation](skills/render-workflows/SKILL.md)
113+
## Auto-approval hooks (Claude Code)
135114

136-
---
115+
The repo ships hook configuration that lets Claude Code auto-approve safe, read-only Render CLI operations:
137116

138-
## Auto-Approval Hooks
117+
- Listing services: `render services list`, `render services -o json`
118+
- Reading logs: `render logs -r`, `render logs --raw`
119+
- Checking workspaces: `render workspace current`, `render workspace list`
139120

140-
Auto-approves safe, read-only CLI operations:
141-
142-
- **Listing services**: `render services list`, `render services -o json`
143-
- **Reading logs**: `render logs -r`, `render logs --raw`
144-
- **Checking workspaces**: `render workspace current`, `render workspace list`
145-
146-
Operations that modify infrastructure still require permission:
147-
148-
- Deployments (`render deploy`)
149-
- Service restarts (`render services restart`)
150-
- Service creation/deletion (`render services create`, `render services delete`)
151-
- Configuration changes (`render services update`)
152-
- Workspace changes (`render workspace set`)
153-
154-
---
155-
156-
## Prerequisites
157-
158-
- Render MCP tools configured with an API key
159-
- `RENDER_API_KEY` environment variable
160-
- Git repository pushed to GitHub, GitLab, or Bitbucket (for deploys)
161-
- Optional: Render CLI for streaming logs/SSH
162-
163-
## Quick Start
164-
165-
Deploy: "Deploy my application to Render"
166-
Debug: "Debug my Render deployment"
167-
Monitor: "Is my Render service healthy?"
168-
Migrate: "Migrate my Heroku app to Render"
169-
Workflows: "Set up Render Workflows in my project"
170-
Add tasks: "Add a new workflow task with retries"
171-
172-
---
121+
Anything that changes infrastructure still requires explicit approval, including deploys, restarts, service creation and deletion, configuration changes, and workspace changes.
173122

174123
## Contributing
175124

176-
### Adding a New Skill
125+
### Add a new skill
126+
127+
1. Create `skills/your-skill-name/` with a `SKILL.md`.
128+
2. Add supporting files as needed: `references/`, `assets/`, and `evals.json`.
129+
3. Add frontmatter at the top of `SKILL.md`:
177130

178-
1. Create `skills/your-skill-name/` with `SKILL.md` (optional `references/`, `assets/`).
179-
2. Add frontmatter in `SKILL.md`:
180131
```yaml
181132
---
182133
name: your-skill-name
183-
description: Brief description
134+
description: One sentence describing when an agent should use this skill.
184135
license: MIT
185136
compatibility: Prerequisites and requirements
186137
metadata:
187138
author: Render
188139
version: "1.0.0"
189-
category: category-name
140+
category: deployment
190141
---
191142
```
192-
3. Keep `SKILL.md` concise; move details to `references/`.
193-
4. Test locally:
194-
```bash
195-
claude plugin add /path/to/skills
196-
```
197143

198-
Examples: [deploy](skills/render-deploy/), [debug](skills/render-debug/), [monitor](skills/render-monitor/), [render-migrate-from-heroku](skills/render-migrate-from-heroku/), [workflows](skills/render-workflows/).
144+
4. Keep `SKILL.md` short and action-oriented. Move depth into `references/`.
145+
5. Test locally with your target tool.
199146

200-
---
147+
For reference, look at [`render-deploy`](skills/render-deploy/), [`render-debug`](skills/render-debug/), [`render-monitor`](skills/render-monitor/), or [`render-workflows`](skills/render-workflows/).
201148

202-
## Repository Structure
149+
## Repository structure
203150

204-
```
205-
render-skill/
206-
├── .claude-plugin/
207-
│ ├── plugin.json # Plugin manifest
208-
│ └── marketplace.json # Marketplace metadata
209-
├── skills/
210-
│ ├── render-deploy/ # Deployment skill
211-
│ ├── render-debug/ # Debugging skill
212-
│ ├── render-monitor/ # Monitoring skill
213-
│ ├── render-migrate-from-heroku/ # Heroku migration skill
214-
│ └── render-workflows/ # Workflows setup, development, and deployment
215-
├── hooks/
216-
│ ├── hooks.json # Hook configuration
217-
│ └── auto-approve-render.sh # Auto-approval script
218-
├── scripts/
219-
│ └── install.sh # Multi-tool installer
220-
├── .mcp.json # MCP server configuration
221-
├── README.md # This file
222-
├── .gitignore
151+
```text
152+
skills/
153+
├── .github/workflows/ # CI
154+
├── hooks/ # Auto-approval hook config for Claude Code
155+
├── scripts/ # Install and helper scripts
156+
├── skills/ # 21 skill directories
157+
├── README.md
223158
└── LICENSE
224159
```
225160

226-
---
227-
228161
## Support
229162

230-
- **Documentation:** https://render.com/docs
231-
- **Issues:** https://github.com/render-oss/skills/issues
232-
- **Render Support:** support@render.com
233-
234-
---
163+
- Documentation: <https://render.com/docs>
164+
- Issues: <https://github.com/render-oss/skills/issues>
165+
- Render Support: <mailto:support@render.com>
235166

236167
## License
237168

238-
MIT License - see [LICENSE](LICENSE) file for details.
169+
MIT License. See [LICENSE](LICENSE).

0 commit comments

Comments
 (0)