Skip to content

INSTALL.en.md

Latest commit

 

History

History
127 lines (84 loc) · 2.56 KB

INSTALL.en.md

File metadata and controls

127 lines (84 loc) · 2.56 KB
Raw

Installation Guide

1. Prerequisites

Before installing this skill, confirm that:

  • you have Codex with support for custom skills
  • Node.js and npm are installed
  • npx is available

Check with:

node --version
npm --version
command -v npx

If npx is missing, install Node.js first.

2. Recommended Installation

Option 1: Clone the repository and copy the skill directory

git clone https://github.com/SC123667/html-ui-prototype-migrator.git
mkdir -p ~/.codex/skills
cp -R ./html-ui-prototype-migrator/html-ui-prototype-migrator ~/.codex/skills/

Restart Codex afterwards.

Option 2: Download only the skill directory and place it manually

Copy the repository folder:

html-ui-prototype-migrator/

into:

~/.codex/skills/

The final layout should look like:

~/.codex/skills/html-ui-prototype-migrator/
  SKILL.md
  agents/
  references/
  scripts/

3. Verify Installation

Confirm that these files exist:

  • ~/.codex/skills/html-ui-prototype-migrator/SKILL.md
  • ~/.codex/skills/html-ui-prototype-migrator/scripts/playwright_cli.sh
  • ~/.codex/skills/html-ui-prototype-migrator/scripts/task_dir.sh
  • ~/.codex/skills/html-ui-prototype-migrator/scripts/cleanup_task.sh

Optional check:

bash ~/.codex/skills/html-ui-prototype-migrator/scripts/playwright_cli.sh --help

If you see Playwright CLI help output, the basic installation is working.

4. How To Use

After restarting Codex, trigger the skill with a prompt such as:

Use $html-ui-prototype-migrator to build a temporary browser prototype, debug it visually, and migrate it into my project after I approve it.

5. Update

If you installed it from a git clone:

cd html-ui-prototype-migrator
git pull
rm -rf ~/.codex/skills/html-ui-prototype-migrator
cp -R ./html-ui-prototype-migrator ~/.codex/skills/

Then restart Codex.

6. Uninstall

rm -rf ~/.codex/skills/html-ui-prototype-migrator

7. Troubleshooting

The skill does not appear

Common causes:

  • Codex was not restarted
  • the directory was copied to the wrong location
  • the skill folder nesting is incorrect

The correct directory should be:

~/.codex/skills/html-ui-prototype-migrator/

Playwright commands fail

Typical causes:

  • Node.js / npm is not installed
  • npx is not available
  • the first Playwright CLI run needs network access

The prototype works but migration cannot proceed

This usually means the target software is not suitable for an HTML/CSS/JS-based UI, or the target project path has not been provided yet.