cs-onboard 是做什么的？
Onboards new or documentation-sparse repositories into the CodeStable ecosystem. Automatically determines two paths: builds a skeleton from scratch for empty repos, or performs an audit + migration mapping for repos with existing docs.
Trigger phrases: The user says "use CodeStable in this project," "setup CodeStable structure," "initialize CodeStable," "migrate to CodeStable."
How It Works
- Repository State Detection – The skill first checks whether the repository is empty or contains any existing documentation files.
- Path 1: Empty Repo (Scaffolding) – If the repo is empty, the skill will:
- Create a top-level
docs/directory. - Generate required CodeStable configuration files (e.g.,
codestable.yml). - Add a README.md with standard CodeStable headers.
- Create a top-level
- Path 2: Existing Docs (Audit & Migration) – If the repo already has documentation files:
- Audit phase: Scan all doc files, record their structure, naming conventions, and content topics.
- Migration mapping phase: Generate a migration plan that maps existing files to appropriate CodeStable locations and suggests necessary restructuring.
- User Confirmation – The skill presents the plan or skeleton to the user for approval before making any changes.
Platform Support
This skill is designed for use with:
- Claude Code
- Cursor
- Codex (and other agent-based coding tools)
It executes CLI commands and file operations directly within the target repository.
Usage Example
User: "Set up CodeStable in my new project."
Agent (invoking cs-onboard): "Detecting repository state... Empty repo found. Proceeding with scaffolding path."
User: "Migrate my current documentation to CodeStable."
Agent (invoking cs-onboard): "Running audit on existing docs... Generating migration mapping..."
Notes
- All file operations are performed within the current working directory.
- The skill does not modify existing code files, only documentation and configuration.
- If a
.codestableignorefile exists, it will be respected during the audit phase.