salvo-rs/salvo-skills

AI agent skills for the Salvo web framework. These skills help AI assistants understand and generate Salvo code more effectively.

What are Agent Skills?

Agent Skills are specialized knowledge modules that AI assistants can load to perform specific tasks. They follow the Agent Skills open standard and work with tools like GitHub Copilot, Claude Code, and other AI coding assistants.

Available Skills (28 Total)

Core Framework

Data Handling

Security

Real-time Communication

Performance & Operations

Advanced Features

Quick Start

For GitHub Copilot / VS Code

1. Copy the skill directories to your project:

   cp -r salvo-skills/salvo-* .github/skills/
   

2. Enable agent skills in VS Code settings:

   {
     "chat.useAgentSkills": true
   }
   

3. Skills will automatically activate when you ask Copilot about Salvo!

For Claude Code

1. Copy the skill directories to your project:

   cp -r salvo-skills/salvo-* .claude/skills/
   

2. Skills will be automatically loaded when working with Salvo code.

Usage Examples

Once installed, you can ask your AI assistant questions like:

• “Create a basic Salvo web server with a hello world endpoint”
• “Add JWT authentication to my Salvo API”
• “How do I extract JSON data from a POST request in Salvo?”
• “Set up a WebSocket chat handler in Salvo”
• “Generate OpenAPI documentation for my Salvo endpoints”
• “Configure CORS for my API”
• “Add rate limiting to protect my endpoints”
• “Set up HTTPS with Let’s Encrypt”
• “Implement graceful shutdown for my server”
• “Add CSRF protection to my forms”
• “Create a file upload endpoint with validation”

The AI will use these skills to provide accurate, framework-specific guidance.

Key Concepts Covered

Handlers and Routing

• Rust 1.94 or newer for Salvo 1.0
• #[handler] macro for request handlers
• Path parameters with {id} syntax
• Nested routers with push()
• HTTP method handlers (get, post, put, patch, delete)

Middleware

• Using hoop() to attach middleware
• FlowCtrl for flow control
• Depot for request-scoped data sharing
• Onion model execution order

Data Extraction

• JsonBody for JSON requests
• req.param(), req.query() for parameters
• Extractible derive macro for complex extraction
• Validation with validator crate

Database Integration

• affix_state::inject() for dependency injection
• depot.get_typed::() for retrieving state
• SQLx, SeaORM, Diesel support

Authentication & Security

• JWT with JwtAuth middleware
• Basic Auth with BasicAuthValidator
• Session-based auth with SessionHandler
• Role-based access control (RBAC)
• CORS configuration
• CSRF protection
• Rate limiting

Real-time Communication

• WebSocket with WebSocketUpgrade
• SSE with SseEvent and SseKeepAlive
• Broadcasting patterns
• Connection management

Performance

• Response compression (gzip, brotli, zstd)
• Caching strategies
• HTTP/2 and HTTP/3 support
• Concurrency limiting
• Request timeouts

Operations

• Graceful shutdown with ServerHandle
• Logging with tracing
• Request timing and metrics

OpenAPI

• #[endpoint] macro for documentation
• ToSchema and ToParameters derives
• SwaggerUi integration

Skill Structure

Each skill contains:

• SKILL.md - Main skill file with YAML frontmatter and instructions
• Examples - Code snippets demonstrating common patterns
• Best Practices - Framework-specific recommendations
• Setup Instructions - Dependencies and configuration

Contributing

Contributions are welcome! To add or improve skills:

1. Fork the repository
2. Create a new skill directory or modify existing ones
3. Follow the Agent Skills specification
4. Submit a pull request

Skill Format

Each skill must have a SKILL.md file with:

---
name: skill-name
description: Brief description of what the skill does and when to use it
---

# Skill Title

Detailed instructions, examples, and best practices...

License

These skills are part of the Salvo project and follow the same license.

Links

• Salvo Framework
• Salvo Documentation
• Agent Skills Specification
• Discord Community

Support

If you find these skills helpful, please consider:

• Starring the Salvo repository
• Joining our Discord community
• Contributing improvements and new skills

---