Skip to content

Installation

thitichaya edited this page Jun 12, 2026 · 7 revisions

Installation

Canonical install steps also live in the README. Agent matrix: Supported-AI-Agents.


Step 1 — Everyone (same command)

curl -sL https://raw.githubusercontent.com/Thitic9203/helix/main/scripts/install.sh | bash

This clones Helix to ~/.helix/tc-fe-prep, symlinks all workflow skills into global agent folders, enables Claude marketplace plugin helix@helix (disables legacy helix@local), and registers SessionStart hooks (bootstrap + auto-update).


Step 2 — By agent

Agent / IDE After the install script Optional: skills in your git repo
Claude Code Open project → /helix HELIX_LINK_WORKSPACE=$PWD ~/.helix/tc-fe-prep/scripts/link-skills.sh
Cursor Reload window → @helix Same workspace command
Codex Run in project folder → skills auto-discovered Same
GitHub Copilot Enable Agent Skills → skill helix Recommended: workspace link → .github/skills/
Gemini CLI gemini/skills listhelix Workspace link → .gemini/skills/
Windsurf @helix in Cascade Workspace link → .windsurf/skills/
Cline Enable Skills → helix Workspace link → .cline/skills/
OpenCode / Pi Per tool skill UI Workspace link → .agents/skills/

Workspace link (from project root):

HELIX_LINK_WORKSPACE=$PWD ~/.helix/tc-fe-prep/scripts/link-skills.sh

Commit .github/skills/ if your team uses Copilot on the same repository.


Health check

bash ~/.helix/tc-fe-prep/scripts/helix-doctor.sh
HELIX_DOCTOR_FIX=1 bash ~/.helix/tc-fe-prep/scripts/helix-doctor.sh   # repair symlinks + plugin
HELIX_LINK_WORKSPACE=$PWD bash ~/.helix/tc-fe-prep/scripts/helix-doctor.sh   # also check project folders

Manual install (contributors)

git clone https://github.com/Thitic9203/helix.git
cd helix
./scripts/setup.sh
git config core.hooksPath scripts/hooks

Update (default: auto-update)

After a one-time install, you usually do not run git pull yourself. Helix checks for a newer VERSION on each new Claude Code / Cursor session (throttled to every 4 hours).

Situation Action
Normal use Open a new agent session — auto-update runs
Force check now HELIX_FORCE_UPDATE=1 bash ~/.helix/tc-fe-prep/scripts/helix-auto-update.sh
Auto-update off Set HELIX_AUTO_UPDATE=0
Removed symlinks bash ~/.helix/tc-fe-prep/scripts/link-skills.sh
Claude /helix stale bash ~/.helix/tc-fe-prep/scripts/claude-plugin-sync.sh or re-run install
Manual fallback cd ~/.helix/tc-fe-prep && git pull

See Troubleshooting if something still fails.

Clone this wiki locally