pharaoh-setup

Automate Pharaoh initial setup in sphinx-needs projects by generating pharaoh.toml.

24|Updated Feb 12, 2026
One-click install
npx skills add https://github.com/useblocks/pharaoh --skill pharaoh-setup-useblocks
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pharaoh-setup
Source: https://github.com/useblocks/pharaoh/tree/main/skills/pharaoh-setup
Command: npx skills add https://github.com/useblocks/pharaoh --skill pharaoh-setup-useblocks

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates the initial setup of Pharaoh in a sphinx-needs project.

Core Features & Use Cases

  • Detects project structure and relevant sphinx-needs configuration to enable smooth onboarding.
  • Generates pharaoh.toml with initial settings, and optionally scaffolds GitHub Copilot agents for enhanced workflows.
  • Supports both single-root and multi-root projects, preserving existing configurations and guiding migrations (e.g., from conf.py to ubproject.toml).
  • Recommends tooling and migration steps when project structure changes are detected.

Quick Start

Run pharaoh:setup to initialize Pharaoh in your sphinx-needs project and scaffold Copilot agents.

Frequently Asked Questions about pharaoh-setup

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

FAQPage Schema
How do I set up Pharaoh in a sphinx-needs project?

To set up Pharaoh in a sphinx-needs project, run pharaoh:setup. It detects your project configuration, generates the pharaoh.toml file, and optionally scaffolds GitHub Copilot agents while guiding you through strictness choices.

Can I initialize Pharaoh in multi-root sphinx-needs projects?

Yes, Pharaoh setup supports both single-root and multi-root sphinx-needs projects. It automatically detects ubproject.toml or conf.py configurations to generate the appropriate pharaoh.toml settings for your specific structure.

Does Pharaoh setup overwrite existing sphinx-needs configuration files?

No, Pharaoh setup is non-destructive and avoids overwriting existing files unless explicitly approved. It preserves your current configurations and safely guides migrations, such as moving from conf.py to ubproject.toml.

What is the best way to scaffold GitHub Copilot agents for sphinx-needs requirements?

The best way to scaffold GitHub Copilot agents for sphinx-needs is using the Pharaoh setup process. It optionally generates Copilot agent configurations alongside your pharaoh.toml file to enhance project workflow integration.

When should I migrate from conf.py to ubproject.toml for project setup?

You should migrate from conf.py to ubproject.toml when your sphinx-needs project structure changes. Pharaoh setup detects these structural changes and recommends the appropriate migration steps and tooling to ensure smooth onboarding.