Install one portable skill for Codex, Claude Code, or both that audits and prepares professional GitHub repositories with explicit mutation boundaries.
Prepare GitHub Project inventories a local project, designs evidence-based repository metadata, makes authorized local readiness improvements, and applies remote GitHub changes only after explicit approval. It keeps local edits, repository creation, metadata changes, and pushes visibly separate.
Requires Node.js 18 or newer and a filesystem-backed Codex or Claude Code skill directory.
From this source checkout:
npm ci
npm test
node ./bin/prepare-github-project.js --target codex --scope projectThis installs the skill into .agents/skills/prepare-github-project in the current project.
From npm:
npx --yes --package=prepare-github-project@latest prepare-github-project --target codex
npx --yes --package=prepare-github-project@latest prepare-github-project --target claude
npx --yes --package=prepare-github-project@latest prepare-github-project --target bothStart a new agent session after installation so the host refreshes its skill catalog.
In Codex:
Use $prepare-github-project to audit this project and prepare a safe GitHub repository setup plan.
In Claude Code:
/prepare-github-project Audit this project and prepare a safe GitHub repository setup plan.
The bundled local auditor provides a bounded inventory before human review:
node skills/prepare-github-project/scripts/audit-github-project.mjs --path . --json- Inventory recognized manifests, community files, workflows, Git state, and obvious sensitive filenames.
- Flag missing repository metadata, stale pre-publication wording, and selected CI text mismatches.
- Propose a factual description, verified homepage, focused topics, visibility, and default branch.
- Prepare local community, security, manifest, and CI changes when authorized.
- Create or configure GitHub repositories only after explicit authorization.
- Read back repository settings, branch SHAs, workflows, and community profile after changes.
- Report partial remote success without attempting destructive compensation.
| Option | Behavior |
|---|---|
--target codex|claude|both |
Required installation host |
--scope user|project |
User installation by default; project-local when requested |
--path /absolute/skills/root |
Custom skills root for exactly one target |
--dry-run |
Print destinations without writing |
--force |
Atomically replace an existing directory installation |
--help |
Show installer help |
--version |
Print the package version |
User installations go to ~/.agents/skills for Codex and ${CLAUDE_CONFIG_DIR:-~/.claude}/skills for Claude Code. Project installations go to .agents/skills and .claude/skills in the current directory. The installer refuses to replace symlinks or non-directories, including with --force.
The npm executable copies the portable skills/prepare-github-project directory into the selected host's skill root. Installation does not inspect a project, create a repository, change GitHub metadata, or push commits; those actions occur only when the installed skill is invoked with explicit authority.
- Filename checks do not prove that a repository or its history contains no secrets.
- Workflow text checks do not prove CI semantics or runtime success.
- A configured Git remote does not prove GitHub ownership, visibility, or repository settings.
- The skill requires explicit authorization before repository creation, metadata mutations, visibility changes, branch changes, or pushes.
- It never invents deployment URLs, security contacts, licenses, badges, or support channels.
npm ci
npm test
npm run pack:checknpm test runs auditor regressions, installer safety tests, and package-contract checks. npm run pack:check previews the files that would be published; only bin/ and skills/ are included alongside npm-required package metadata and documentation.
The prepublishOnly gate runs both commands before npm publication.
Rerun the @latest installation command with --force to replace an older installation. To uninstall, remove only the prepare-github-project directory from the relevant user or project skill root listed above.
Read CONTRIBUTING.md for requirements, the local workflow, required checks, and pull-request guidance.
Read SUPPORT.md and use GitHub Issues for reproducible bugs and focused requests. Report vulnerabilities privately according to SECURITY.md, never through a public issue. The SupportKori link is funding, not technical support.
Optional support through SupportKori helps maintain the repository-readiness workflows.
Built and maintained by Montasim.
Prepare GitHub Project is available under the MIT License.