rulesy-workflow

Configure, run, and debug Rulesy workspace health checks defined in YAML.

Updated Nov 7, 2025
One-click install
npx skills add https://github.com/notwillk/rulesy --skill rulesy-workflow-notwillk
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: rulesy-workflow
Source: https://github.com/notwillk/rulesy/tree/main/skills/rulesy-workflow
Command: npx skills add https://github.com/notwillk/rulesy --skill rulesy-workflow-notwillk

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve? Setting up and maintaining workspace health checks with the Rulesy CLI involves YAML configuration details, severity semantics, remote config caching, and fix-mode behavior that are easy to get wrong. This Skill provides the operational knowledge to write valid .rulesy.yaml files, troubleshoot failures, and integrate checks into CI/CD without trial and error. ## Core Features & Use Cases - Configuration authoring: Build .rulesy.yaml files with preconditions, rules, severities (debug/info/warn/error), patterns, and file or git-based remote configs. - Fix mode guidance: Use --fix and interactive-fix repairs correctly, including --non-interactive behavior for headless CI runs. - CI/CD integration: Apply ready-made templates for GitHub Actions and GitLab CI, including rulesy install for caching git remotes. - Troubleshooting: Resolve common errors such as uncached git remotes, invalid remote rules, severity misconfigurations, and Windows-specific issues. - Use Case: A developer wants shared team checks across repositories; the Skill explains the git+<url>#<ref>:<path> remote format and the required rulesy install step. ## Quick Start Ask the assistant to create a .rulesy.yaml for your project with a precondition that dependencies are installed and an error-severity rule that runs your test command.

Frequently Asked Questions about rulesy-workflow

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

FAQPage Schema
How do I set up a .rulesy.yaml config for my project?

Create a .rulesy.yaml with a rules array where each rule has a check shell command and an optional severity, fix, and hint. Add preconditions for prerequisites like installed dependencies, and run rulesy init to generate a starter config.

How do I share Rulesy configs across multiple repositories?

Use git-based remote configs with the format git+<url>#<ref>:<path> in a rule's remote property. Run rulesy install first to cache the remote, and pin to a tag like #v1.0.0 for stability.

How do I run only certain severity checks in Rulesy?

Use the --check-severity (or --cs) flag to set the minimum severity to run, and --fail-severity (or --fs) to control which severities cause failure. For example, rulesy check --cs warn --fs error runs warn-and-above rules but only fails on errors.

Why does Rulesy report 'git remote not cached'?

This error occurs when a git-based remote config has not been downloaded to the local cache yet. Run rulesy install to cache all git remotes, or use rulesy check --fix to cache them automatically.

Can Rulesy auto-fix failing checks in CI pipelines?

Yes, rules with a fix property run their repair command when check --fix is enabled, then re-run the check. In CI, use --fix --non-interactive so ordinary fixes run while terminal-dependent interactive-fix repairs are prohibited.

Does Rulesy work on Windows?

Rules run via bash -c on all platforms, so Windows requires Git Bash, WSL, or Cygwin. Use forward slashes in patterns and ensure shell scripts use LF line endings, configurable via .gitattributes.