Skip to content
Get packs

Publish Project to GitHub

Package a local web project into a clean GitHub repo with a README, preview, and GitHub Pages site.

Source Download skill
Repository
MengTo/Skills
Stars
7,187
Licence
MIT
Files
5 files

What it does

When installed, the agent follows a structured process for taking a finished local project (typically a small HTML/CSS/JavaScript site) and publishing it to GitHub. It audits the project for secrets and private files, writes a project-specific README, checks the site runs locally, commits only the intended files, and can turn on GitHub Pages so the project gets a public live URL. It also reads back the results to confirm the deployed site actually works.

Great for

  • Developers who built a small static web experiment and want a documented public GitHub repo with a live demo
  • Designers or creators sharing a finished interactive web piece and needing a tidy repository
  • Teams that want a repeatable pre-publish checklist covering secrets, licensing, and Pages setup

Skip it if

  • Projects with servers, databases, or private runtimes, since GitHub Pages cannot host them and the skill says so rather than working around it
  • Anyone wanting to publish a mixed or private workspace quickly; the skill intentionally refuses to publish whole folders and will ask for scope and visibility, which can slow things down
  • Users who have not reviewed the audit results: the audit script is a pattern-based check and the skill itself says it does not replace human judgment

Try asking

  • “Publish my finished HTML game in this folder to a public GitHub repo with a live demo”
  • “Make a README with a screenshot for my local web project and push it to GitHub as a private repo”
  • “Check this project for leaked API keys or .env files before I open-source it”
  • “Set up GitHub Pages for my static docs folder and verify the live URL works”
Step-by-step guide: how to use Publish Project to GitHubInstall, first run, examples, tips and FAQs

Install in 3 steps

  1. 1

    Download the skill

    The ZIP contains the 5 original files, the MIT licence and an attribution note.

    publish-project-to-github.zip
  2. 2

    Add it to your agent

    Claude Code (all projects)

    mkdir -p ~/.claude/skills && unzip publish-project-to-github.zip -d ~/.claude/skills/

    Claude Code / Agent SDK (this project only)

    mkdir -p .claude/skills && unzip publish-project-to-github.zip -d .claude/skills/

    Claude apps (web/desktop): Settings → Capabilities → Skills → Upload skill, and choose the ZIP.

  3. 3

    Ask for the task

    No special command needed — the agent reads the skill's description and loads it when your request matches. Try one of the prompts above.

Get better results

  • State explicitly whether you want a public or private repository; the skill will not create a public one without clear authorization
  • Give the exact project folder and repository name so the agent does not guess which files to publish
  • Review the audit output and any flagged files yourself before allowing the push, and confirm your project has a license if you want others to reuse it

What's inside

  • agents/openai.yaml
  • assets/README-template.md
  • references/github-pages.md
  • scripts/audit_public_project.sh
  • SKILL.md

Redistributed unmodified from MengTo/Skills under the MIT licence. The assessment was drafted with AI from the skill's files on 2026-10-29. Skills can instruct your agent to run code — read SKILL.md and any scripts before installing.