plain-guide

Answer questions about the Plain framework by researching docs and source code. Use when asked "how do I...", "does Plain support...", or "how does X work?" questions.

654 stars

Best use case

plain-guide is best used when you need a repeatable AI agent workflow instead of a one-off prompt.

Answer questions about the Plain framework by researching docs and source code. Use when asked "how do I...", "does Plain support...", or "how does X work?" questions.

Teams using plain-guide should expect a more consistent output, faster repeated execution, less prompt rewriting.

When to use this skill

  • You want a reusable workflow that can be run more than once with consistent structure.

When not to use this skill

  • You only need a quick one-off answer and do not need a reusable workflow.
  • You cannot install or maintain the underlying files, dependencies, or repository context.

Installation

Claude Code / Cursor / Codex

$curl -o ~/.claude/skills/plain-guide/SKILL.md --create-dirs "https://raw.githubusercontent.com/dropseed/plain/main/.claude/skills/plain-guide/SKILL.md"

Manual Installation

  1. Download SKILL.md from GitHub
  2. Place it in .claude/skills/plain-guide/SKILL.md inside your project
  3. Restart your AI agent — it will auto-discover the skill

How plain-guide Compares

Feature / Agentplain-guideStandard Approach
Platform SupportNot specifiedLimited / Varies
Context Awareness High Baseline
Installation ComplexityUnknownN/A

Frequently Asked Questions

What does this skill do?

Answer questions about the Plain framework by researching docs and source code. Use when asked "how do I...", "does Plain support...", or "how does X work?" questions.

Where can I find the source code?

You can find the source code on GitHub using the link provided at the top of the page.

SKILL.md Source

# Plain Guide

Research the user's question using `plain docs` and source code, then provide a clear answer.

## 1. Use a subagent for research

Always use the Agent tool to research the question. You almost never know the exact package and section name ahead of time, so let the subagent discover them. This also keeps research output out of the main conversation.

Use the Agent tool with a prompt like:

> Research this Plain framework question: {question}
>
> Start by discovering where the answer lives:
>
> - `uv run plain docs --search <term>` — find relevant packages/sections
> - `uv run plain docs <name> --outline` — see section headings for a package
>
> Then read the relevant content:
>
> - `uv run plain docs <name> --section <section>` — specific section
> - `uv run plain docs <name> --api` — public API surface
> - Use Grep/Read to examine source code when docs are insufficient
>
> Return a clear answer with:
>
> - Working code examples (with imports)
> - Which packages are involved
> - Any gotchas or common mistakes

## 2. Answer the question

- Lead with the answer, not a summary of your research
- Include copy-paste ready code examples with imports
- If the answer spans multiple packages, explain how they connect
- If the user is using Django terminology, translate to Plain equivalents
- If a needed package isn't installed, mention `/plain-install`
- Do NOT fabricate APIs — if unsure, verify with `--api` first

Related Skills

plainx-release

654
from dropseed/plain

Releases plainx packages with version suggestions, changelog generation, and git tagging. Use when releasing a package to PyPI.

plain-upgrade

654
from dropseed/plain

Upgrades Plain packages and applies required migration changes. Use when updating to newer package versions.

plain-postgres-doctor

654
from dropseed/plain

Check overall database health — schema correctness and operational health. Use when asked to check the database, validate schema, optimize indexes, or diagnose Postgres problems.

plain-portal

654
from dropseed/plain

Open a remote Python shell on a production machine via encrypted tunnel. Use when you need to inspect production data, debug issues, run queries, or transfer files.

plain-optimize

654
from dropseed/plain

Captures and analyzes performance traces to identify slow queries and N+1 problems. Use when a page is slow, there are too many queries, or the user asks about performance.

plain-install

654
from dropseed/plain

Installs Plain packages and guides through setup steps. Use when adding new packages to a project.

plain-bug

654
from dropseed/plain

Submit a bug report for the Plain framework. Use when the user wants to report a bug, error, or unexpected behavior. Collects context and creates a GitHub issue.

release

654
from dropseed/plain

Releases Plain packages with intelligent version suggestions and parallel release notes generation. Use when releasing packages to PyPI.

future

654
from dropseed/plain

Navigate and manage the future/ directory — view dependency graphs, filter by arc, find unblocked futures, and identify what to work on next. Use when deciding what to work on, exploring planned work, or checking dependencies between futures.

claude-code-guide

31392
from sickn33/antigravity-awesome-skills

To provide a comprehensive reference for configuring and using Claude Code (the agentic coding tool) to its full potential. This skill synthesizes best practices, configuration templates, and advanced usage patterns.

china-relocation-guide

3891
from openclaw/skills

Use when expats, international students, or digital nomads need guidance on relocating to China, choosing cities, understanding visa requirements, or planning their move.

Relocation Guides

explainer

3891
from openclaw/skills

Create explainer videos with narration and AI-generated visuals. Triggers on: "解说视频", "explainer video", "explain this as a video", "tutorial video", "introduce X (video)", "解释一下XX(视频形式)".

Content & Documentation