sync-project-to-github

English | 简体中文

Prepare a local vibe-coded app or website as a safe, understandable, and runnable GitHub repository, then synchronize later changes without overwriting remote work.

Capabilities

• Detect the project root, stack, package manager, environment variables, and runnable commands.
• Review secrets, private data, generated files, large artifacts, symlinks, and Git history before publishing.
• Create or improve sharing essentials such as README.md, .env.example, ignore rules, and GitHub repository metadata.
• Validate the project with its existing lint, test, type-check, or build commands when feasible.
• Publish, connect, or synchronize without force-pushing or silently resolving divergent history.
• Return a verified repository URL and optionally offer deployment as a separate follow-up.

Installation

Copy or clone this repository into your personal Codex Skills directory:

~/.codex/skills/sync-project-to-github/

The directory must contain SKILL.md at its root. Restart Codex after installation so the Skill catalog reloads.

Example invocation

Use $sync-project-to-github to prepare this vibe-coded project and publish it as a shareable GitHub repository.

Codex will inspect and prepare the project first, then show the target repository, visibility, file changes, validation results, exclusions, and commit message for final confirmation before creating or pushing anything on GitHub.

Repository contents

• SKILL.md — workflow, safety boundaries, and publishing behavior.
• agents/openai.yaml — Codex UI metadata and default invocation prompt.
• references/project-types.md — project-type detection and repository-content heuristics.
• references/sharing-readiness.md — README, environment, reproducibility, and GitHub presentation guidance.

License

This project is licensed under the MIT License.