Terminal
Terminal/Skill
Lets your agent look up Devvit API docs, patterns, and examples from Reddit's official devvit-docs repository.
By Reddit
Works with
npx skills add reddit/devvit-skills --skill devvit-docsLook up Devvit documentation from reddit/devvit-docs.
Constraints:
reddit/devvit-docs as the source of truth.ensure-docs.cjs script to clone or refresh the project-local docs cache.searchRoots directory, in order, using rg when available or another recursive text-search tool as a fallback. Search exact API names and relevant keywords, then open the strongest matches and read their surrounding sections.excludeRoots.cacheStatus is cached, rerun the script once with --force and search again.repoDir as a fallback while still excluding excludeRoots.repoDir.node ./scripts/ensure-docs.cjs [--force] [--ttl <hours>] [--project-dir <path>] [--cache-dir <path>]
Script path is relative to this skill's directory.
--force — Pull regardless of cache age--ttl <hours> — Cache TTL in hours (default: 24)--project-dir <path> — User's project root for version detection (default: cwd)--cache-dir <path> — Cache base directory. Stores the clone in <path>/devvit-docs (default: <project-dir>/node_modules/.cache/devvit-skills)Examples:
node ./scripts/ensure-docs.cjs
node ./scripts/ensure-docs.cjs --force
node ./scripts/ensure-docs.cjs --cache-dir ./tmp/devvit-cache
{
"cacheStatus": "cached",
"docsRoot": "/path/to/project/node_modules/.cache/devvit-skills/devvit-docs/versioned_docs/version-0.11",
"repoDir": "/path/to/project/node_modules/.cache/devvit-skills/devvit-docs",
"searchRoots": [
"/path/to/project/node_modules/.cache/devvit-skills/devvit-docs/versioned_docs/version-0.11",
"/path/to/project/node_modules/.cache/devvit-skills/devvit-docs/docs/api/redditapi"
],
"excludeRoots": [
"/path/to/project/node_modules/.cache/devvit-skills/devvit-docs/docs/api/public-api"
],
"matchedVersion": true,
"appDevvitVersion": "0.11",
"docsRepoCommit": "3f4f2d1c0b0e..."
}
cacheStatus — cloned if this run created or replaced the clone; otherwise cached.docsRoot — Primary docs directory. Versioned if a matching version was found, otherwise docs/.repoDir — Root of the cloned repo (use as fallback if versioned docs are incomplete).searchRoots — Directories to search in order. Includes docsRoot and the latest docs/api/redditapi reference when present.excludeRoots — Directories to exclude from searches and citations. Includes docs/api/public-api when present.matchedVersion — Whether docsRoot matched the detected app version.appDevvitVersion — Devvit version from the user's package.json, or null.docsRepoCommit — Commit hash of the docs repo cache, or null if unavailable.git not found — Requires git on PATH.sparse-checkout and partial clone support.--force to bypass the TTL cache.