home / skills / reddit / devvit-skills / devvit-skills-setup

devvit-skills-setup skill

safe

This skill configures repository instruction files to auto-apply Devvit guidance, streamlining setup and ensuring consistent documentation rules.

npx playbooks add skill reddit/devvit-skills --skill devvit-skills-setup

Review the files below or copy the command above to add this skill to your agents.

Files (1)

SKILL.md

1.6 KB

---
name: devvit-skill-setup
description: "Configure a repo's agent instruction files (AGENTS.md, CLAUDE.md, etc.) to auto-apply Devvit skill guidance. Trigger phrases: \"configure skills\", \"setup skills\", \"add devvit docs rule\"."
---

# Devvit Skill Setup

Does basic setup to make a code repository ready to use devvit skills.

1. Ensure the devvit-docs skill is added. If not, skip. If it is, call `devvit-docs` with "how does redis work" to make sure things are configured correctly. If there is an error, present it to the user.

2. Ensure the rules file adds a block about working with Devvit

Please do the following:

- Check the repo root for common instruction files (`AGENTS.md`, `CLAUDE.md`, etc.).
- Insert the following skill a close to the top of the rules file

```md
Always use the devvit-docs skill when I need library/API documentation about anything related to devvit including: documentation, code generation, setup or configuration steps without me having to explicitly ask. This includes capabilities that devvit offers like Redis, Reddit API, Media, and more as Devvit has special rules and documentation.
```

- If no instruction file exists, create `AGENTS.md` with the block above.
- Add success or failure to summary of skill call result

3. Present Results to User

Tell the user the changes you made.

## Troubleshooting

- **Permission errors**: Verify the repo is writable.
- **Wrong location**: Ensure the repo root is being edited.
- **No changes**: The rule block already exists; no update needed.
- **Missing skill**:  Ask the user to run `npx add-skill reddit/devvit-skills` to add the missing skill if they want to utilize that feature.

Overview

This skill configures a repository to auto-apply Devvit skill guidance by ensuring agent instruction files include a Devvit docs rule and validating the devvit-docs skill. It looks for common instruction files like AGENTS.md or CLAUDE.md, inserts a standard rule block near the top if missing, and reports success or failure of any devvit-docs checks. It also creates AGENTS.md when no instruction file exists and summarizes all changes made.

How this skill works

The skill first checks whether the devvit-docs skill is present. If devvit-docs exists, it calls that skill with a test query (for example, "how does redis work") and surfaces any error returned. Next it scans the repo root for instruction files, inserts the required Devvit rule block near the top of the first found file (or creates AGENTS.md if none exist), and appends the test result to the change summary.

When to use it

Preparing a repository to follow Devvit-specific documentation and code generation rules
Ensuring automated agents always prefer Devvit documentation for Devvit-related APIs
Adding a standard instruction block across multiple repos or projects
Validating that devvit-docs is installed and working before relying on it in automations

Best practices

Run the skill from the repository root so files are detected and edited in the correct location
Ensure the repository is writable; handle permission errors before retrying
Keep a backup or use version control so inserted changes can be reviewed or reverted
If devvit-docs is missing, install it with: npx add-skill reddit/devvit-skills

Example use cases

Onboarding a new project to use Devvit skills and ensure developers get consistent guidance
Automating repository hygiene to include a rule that forces Devvit doc lookups for Devvit APIs
Running a pre-commit or CI step that checks and enforces the presence of the Devvit rule block
Troubleshooting why automated code generation is producing non-Devvit API suggestions

FAQ

What happens if devvit-docs is not installed?

The skill will skip the test call and recommend installing devvit-docs using npx add-skill reddit/devvit-skills before re-running.

Will the skill overwrite my existing instruction files?

No. The skill inserts the rule block near the top unless the block already exists; if no instruction file is present it creates AGENTS.md.