ferrox-onboard

Generate a verified repository map and planning artifacts for Ferrox onboarding.

21|9|Updated Jul 21, 2026
One-click install
npx skills add https://github.com/FerroxLabs/ferrox-factory --skill ferrox-onboard
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: ferrox-onboard
Source: https://github.com/FerroxLabs/ferrox-factory/tree/main/skills/ferrox-onboard
Command: npx skills add https://github.com/FerroxLabs/ferrox-factory --skill ferrox-onboard

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you bring an existing codebase into the Ferrox workflow without guessing, by creating a reliable map of the repository and establishing the planning artifacts needed for safe onboarding.

Core Features & Use Cases

  • Codebase Mapping: Generates an evidence-backed map of the existing project so the onboarding process starts from facts, not assumptions.
  • Docs Ingestion and Project Setup: Reads existing documentation and initializes the core planning files used by the Ferrox system.
  • Safe, Idempotent Onboarding: Preserves existing artifacts, follows explicit gates, and produces a concise onboarding summary for the next step.
  • Use Case: A team inherits a legacy repository and wants to prepare it for Ferrox without overwriting current planning files or skipping verification steps.

Quick Start

Ask the assistant to onboard this repository into Ferrox and produce the codebase map, planning artifacts, and onboarding summary.

Frequently Asked Questions about ferrox-onboard

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

FAQPage Schema
How do I onboard an existing codebase into a new workflow without losing current planning files?

To safely onboard an existing codebase, generate an evidence-backed repository map and initialize planning artifacts using an idempotent process that preserves existing files and follows explicit safety gates.

What is the best way to map a brownfield repository before starting project setup?

Mapping a brownfield repository involves analyzing the existing codebase structure to produce a verified, evidence-backed map, ensuring subsequent onboarding and documentation ingestion steps rely on facts rather than assumptions.

How do I prepare legacy documentation for ingestion into a new development workflow?

Preparing legacy documentation for ingestion requires reading existing docs and initializing core planning files, creating a concise onboarding summary that enables a safe handoff into the active workflow.

Can I re-run codebase onboarding without overwriting previously generated planning artifacts?

Yes, you can re-run codebase onboarding safely if the process adheres to strict idempotency, which preserves existing planning artifacts and prevents duplicate or overwritten outputs during repeated executions.

Does codebase onboarding work for brownfield projects with existing documentation?

Yes, codebase onboarding is specifically designed for brownfield repositories, applying documentation ingestion and project setup to safely transition established codebases into the Ferrox workflow.

What are the limitations of automated codebase mapping for complex legacy repositories?

Automated codebase mapping requires strict adherence to safety gates and evidence-backed outputs; it may not capture implicit domain logic, so users must verify the generated repository map and planning artifacts before proceeding.