Dremove installation step

This commit is contained in:
Pedro Rodrigues
2026-01-16 15:17:10 +07:00
parent 4000ac7107
commit 9ac9bcc495
2 changed files with 45 additions and 41 deletions

View File

@@ -1,10 +1,13 @@
# AGENTS.md
This file provides guidance to AI coding agents (Claude Code, Cursor, Copilot, etc.) when working with code in this repository.
This file provides guidance to AI coding agents (Claude Code, Cursor, Copilot,
etc.) when working with code in this repository.
## Repository Overview
A collection of PostgreSQL best practices skills for Claude.ai and Claude Code, maintained by Supabase. Skills are packaged instructions that extend agent capabilities for database optimization.
A collection of PostgreSQL best practices skills for Claude.ai and Claude Code,
maintained by Supabase. Skills are packaged instructions that extend agent
capabilities for database optimization.
## Creating a New Rule
@@ -30,13 +33,15 @@ packages/
### Naming Conventions
- **Rule files**: `{prefix}-{kebab-case-name}.md` (e.g., `query-missing-indexes.md`)
- **Prefixes determine section**: `query-`, `conn-`, `schema-`, `lock-`, `security-`, `data-`, `monitor-`, `advanced-`
- **Rule files**: `{prefix}-{kebab-case-name}.md` (e.g.,
`query-missing-indexes.md`)
- **Prefixes determine section**: `query-`, `conn-`, `schema-`, `lock-`,
`security-`, `data-`, `monitor-`, `advanced-`
- **Special files**: Prefixed with `_` (e.g., `_template.md`, `_sections.md`)
### Rule File Format
```markdown
````markdown
---
title: Clear, Action-Oriented Title
impact: CRITICAL|HIGH|MEDIUM-HIGH|MEDIUM|LOW-MEDIUM|LOW
@@ -54,6 +59,7 @@ tags: relevant, keywords
-- Comment explaining what's wrong
[Bad SQL example]
```
````
**Correct (description):**
@@ -65,8 +71,8 @@ tags: relevant, keywords
**Supabase Note:** [Optional platform-specific guidance]
Reference: [Link](url)
```
````
### Best Practices for Context Efficiency
Skills are loaded on-demand. To minimize context usage:
@@ -86,12 +92,12 @@ cd packages/postgresql-best-practices-build
npm install
npm run validate # Check rule format
npm run build # Generate AGENTS.md
```
````
### Impact Levels
| Level | Improvement | Examples |
|-------|-------------|----------|
| ----------- | ----------- | -------------------------------------- |
| CRITICAL | 10-100x | Missing indexes, connection exhaustion |
| HIGH | 5-20x | Wrong index types, poor partitioning |
| MEDIUM-HIGH | 2-5x | N+1 queries, RLS optimization |
@@ -102,7 +108,7 @@ npm run build # Generate AGENTS.md
### File Prefix to Section Mapping
| Prefix | Section | Priority |
|--------|---------|----------|
| ----------- | ------------------------ | --------------- |
| `query-` | Query Performance | 1 (CRITICAL) |
| `conn-` | Connection Management | 2 (CRITICAL) |
| `schema-` | Schema Design | 3 (HIGH) |
@@ -114,10 +120,5 @@ npm run build # Generate AGENTS.md
### End-User Installation
**Claude Code:**
```bash
npx add-skill supabase/postgres-best-practices
```
**claude.ai:**
Add the skill to project knowledge or paste SKILL.md contents into the conversation.
**claude.ai:** Add the skill to project knowledge or paste SKILL.md contents
into the conversation.

View File

@@ -1,6 +1,7 @@
# Agent Skills
A collection of skills for AI coding agents. Skills are packaged instructions and scripts that extend agent capabilities.
A collection of skills for AI coding agents. Skills are packaged instructions
and scripts that extend agent capabilities.
Skills follow the [Agent Skills](https://agentskills.io/) format.
@@ -8,9 +9,11 @@ Skills follow the [Agent Skills](https://agentskills.io/) format.
### postgresql-best-practices
PostgreSQL performance optimization guidelines from Supabase. Contains rules across 8 categories, prioritized by impact.
PostgreSQL performance optimization guidelines from Supabase. Contains rules
across 8 categories, prioritized by impact.
**Use when:**
- Writing SQL queries or designing schemas
- Implementing indexes or query optimization
- Reviewing database performance issues
@@ -18,6 +21,7 @@ PostgreSQL performance optimization guidelines from Supabase. Contains rules acr
- Working with Row-Level Security (RLS)
**Categories covered:**
- Query Performance (Critical)
- Connection Management (Critical)
- Schema Design (High)
@@ -27,23 +31,21 @@ PostgreSQL performance optimization guidelines from Supabase. Contains rules acr
- Monitoring & Diagnostics (Low-Medium)
- Advanced Features (Low)
## Installation
```bash
npx add-skill supabase/postgres-best-practices
```
## Usage
Skills are automatically available once installed. The agent will use them when relevant tasks are detected.
Skills are automatically available once installed. The agent will use them when
relevant tasks are detected.
**Examples:**
```
Optimize this PostgreSQL query
```
```
Review my schema for performance issues
```
```
Help me add proper indexes to this table
```
@@ -51,6 +53,7 @@ Help me add proper indexes to this table
## Skill Structure
Each skill contains:
- `SKILL.md` - Instructions for the agent
- `AGENTS.md` - Compiled rules document (generated)
- `rules/` - Individual rule files