litestar-styleguide

Centralize code style, testing, and CI/CD conventions for Litestar ecosystem skills.

13|Updated Apr 15, 2026
One-click install
npx skills add https://github.com/litestar-org/litestar-skills --skill litestar-styleguide
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: litestar-styleguide
Source: https://github.com/litestar-org/litestar-skills/tree/main/plugins/litestar/skills/litestar-styleguide
Command: npx skills add https://github.com/litestar-org/litestar-skills --skill litestar-styleguide

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Without a shared baseline, every Litestar skill would duplicate inconsistent rules for code style, testing, CI/CD, and language-specific conventions, leading to fragmented, conflicting guidance for AI agents building Litestar projects.

Core Features & Use Cases

  • Cross-Cutting Style Baseline: Centralizes generic rules for Python (PEP 604 unions, ruff/mypy/pyright), TypeScript, testing (pytest/Vitest), and CI/CD so no individual skill duplicates them.
  • Litestar-Specific Conventions: Codifies framework best practices for route handlers, DTOs, dependency injection, guards, and plugin development.
  • Single Source of Truth: All other Litestar skills link to this baseline instead of copying rules, ensuring consistent guidance across the entire plugin ecosystem.
  • Use Case: When building a Litestar app with advanced-alchemy and Dishka, an AI agent references this skill first to apply consistent type hints, async I/O patterns, and test conventions before implementing skill-specific features.

Quick Start

Use the litestar-styleguide skill to apply consistent Python type hints, async I/O patterns, and Litestar framework conventions when generating new project code.

Frequently Asked Questions about litestar-styleguide

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I enforce consistent code style and testing conventions across a Litestar project?

Enforce consistent Litestar code style by centralizing generic rules for Python, TypeScript, testing, and CI/CD into a single baseline. This eliminates duplicate, inconsistent rules across individual skills by serving as a linked single source of truth.

What's the best way to configure ruff, mypy, and pyright for Litestar framework development?

Configure ruff, mypy, and pyright for Litestar by applying centralized type checking and style conventions. This baseline codifies framework best practices for route handlers, DTOs, and dependency injection to ensure consistent AI agent guidance.

Does this styleguide support both pytest for Python and Vitest for TypeScript testing workflows?

Yes, this styleguide supports both pytest and Vitest testing workflows. It centralizes cross-cutting testing conventions for full-stack Litestar application development, covering both Python and TypeScript to prevent fragmented test guidance across the ecosystem.

How do I standardize async I/O patterns and PEP 604 type syntax in my Litestar application?

Standardize async I/O patterns and PEP 604 type syntax by referencing a centralized Litestar style baseline. This ensures AI agents apply consistent type hints and asynchronous conventions before implementing skill-specific application features.

Why do my Litestar AI agent skills have conflicting code style and CI/CD rules?

Conflicting Litestar AI agent rules occur when individual skills duplicate style, testing, and CI/CD conventions independently. Linking sibling skills to a shared styleguide baseline eliminates this fragmentation and enforces consistent guidance via validation checkpoints.

Can I use this baseline to set up GitHub Actions CI/CD for a Litestar full-stack application?

Yes, you can use this baseline to set up GitHub Actions CI/CD for Litestar applications. It centralizes cross-cutting CI/CD conventions alongside code style and testing rules, ensuring your full-stack Python and TypeScript workflows remain consistent.