An open API service indexing awesome lists of open source software.

https://github.com/thitic9203/helix

Portable QA skill pack for AI agents: test-case preparation, Playwright ticket testing, defect reporting, and Jira retest workflows. For Claude Code, Cursor, and Codex.
https://github.com/thitic9203/helix

agent-skills ai-agent claude-code codex jira playwright qa-automation software-testing test-management testing

Last synced: about 1 month ago
JSON representation

Portable QA skill pack for AI agents: test-case preparation, Playwright ticket testing, defect reporting, and Jira retest workflows. For Claude Code, Cursor, and Codex.

Awesome Lists containing this project

README

          

# Helix — AI QA assistant

**Version: 1.5.22** · [Releases](https://github.com/Thitic9203/helix/releases)

Portable skill pack for AI agents: **FE/API manual test-case prep** (with coverage + quality review), **Playwright ticket testing**, **create bug**, and **Jira bug retests** — one entry menu across tools.

> **Scope & expectations**
> Helix is built for QA work with **clear boundaries**—a defined ticket, environment, inputs, and what “done” looks like. When the scope is vague or still in flux, you may need extra clarification rounds, and the output may require more review. Sharper scope upfront usually means stronger, faster results.

## Why Helix

| Workflow | Summary |
|----------|---------|
| **TC FE Preparation** | Story AC/EC → coverage review → manual FE TC table + CSV/Excel → Jira comment |
| **TC API Preparation** | API spec + Swagger → coverage review → API TC table → comment or CSV/Excel |
| **Retest Bug** | Verify a fix — API/UI, Swagger, evidence, comment, transition |
| **Testing Ticket** | Intake → Playwright → summary in chat → optional result update elsewhere |
| **Create Bug** | Jira/GitHub target + format + details → confirm → file and verify |

TC prep workflows include **AC/EC or spec/Swagger alignment review** and **ISTQB / ISO/IEC/IEEE 29119-3–aligned** manual test-case quality checks (see skill references).

## Supported AI agents

Helix uses the open **[Agent Skills](https://agentskills.io)** format (`SKILL.md`). One install links skills for every path your machine supports.

| Agent / IDE | Supported | Global skills folder (after install) |
|-------------|-----------|--------------------------------------|
| **Claude Code** | Yes | `~/.claude/skills/` + plugin cache |
| **Cursor** | Yes | `~/.cursor/skills/` |
| **OpenAI Codex** | Yes | `~/.codex/skills/` |
| **GitHub Copilot** (VS Code) | Yes | `~/.copilot/skills/` |
| **Gemini CLI** | Yes | `~/.gemini/skills/` |
| **Windsurf Cascade** | Yes | `~/.codeium/windsurf/skills/` |
| **Cline** | Yes | `~/.cline/skills/` |
| **OpenCode** | Yes | `~/.config/opencode/skills/` |
| **Pi** | Yes | `~/.pi/agent/skills/` |
| **Other (Agent Skills)** | Yes | `~/.agents/skills/` (shared alias) |

**Team / repo scope (optional):** `.github/skills/`, `.agents/skills/`, `.windsurf/skills/`, `.cline/skills/`, `.gemini/skills/` when you run workspace linking (below).

Details: [docs/supported-agents.md](docs/supported-agents.md) · copy-paste prompts: [references/agent-entry.md](references/agent-entry.md)

Web-only chat without skill discovery is not supported — use an agent that loads `SKILL.md` folders.

## Install (one-time)

### Step 1 — Everyone (same command)

```bash
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 the global folders above (skips paths that do not exist on your OS yet), registers the **Claude Code** plugin cache, enables **`helix@helix`** (and disables legacy `helix@local`), and wires **SessionStart** hooks for bootstrap + **auto-update**.

### Step 2 — By agent (what you do next)

| Agent / IDE | After the install script | Optional: skills in your git repo (team) |
|-------------|------------------------|------------------------------------------|
| **Claude Code** | Open the project → run `/helix` | `HELIX_LINK_WORKSPACE=$PWD ~/.helix/tc-fe-prep/scripts/link-skills.sh` |
| **Cursor** | Reload window → `@helix` or ask for skill **helix** | Same `HELIX_LINK_WORKSPACE=…` from repo root |
| **Codex** | Run Codex in a folder → skills auto-discovered | Same workspace command → `.agents/skills/` etc. |
| **GitHub Copilot** | VS Code: ensure Agent Skills enabled → skill **helix** in chat | **Recommended:** workspace link → `.github/skills/` |
| **Gemini CLI** | `gemini` → `/skills list` → use **helix** | Workspace link → `.gemini/skills/` or `.agents/skills/` |
| **Windsurf** | `@helix` in Cascade | Workspace link → `.windsurf/skills/` |
| **Cline** | Enable Skills → pick **helix** | Workspace link → `.cline/skills/` |
| **OpenCode / Pi** | Open project → skill list per tool docs | Workspace link → `.agents/skills/` |

**Workspace link (one line, from your project root):**

```bash
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 (`helix doctor`)

After install (or when skills do not appear):

```bash
bash ~/.helix/tc-fe-prep/scripts/helix-doctor.sh
# optional: also check project skill folders
HELIX_LINK_WORKSPACE=$PWD bash ~/.helix/tc-fe-prep/scripts/helix-doctor.sh
```

Reports Helix version, global skill symlinks per agent, and Claude plugin cache. **Works best with:** Jira (MCP or logged-in browser), Playwright in your app repo, optional `references/*-guide.md` in your project.

## Usage

**You do not have to start with `/helix`.** If you already know the workflow, call it directly — that skips the menu and is the recommended path. Use `/helix` (or skill **`helix`**) only when you want the menu or are unsure which workflow fits.

### Run a workflow directly (recommended when you know the goal)

| Goal | Claude Code | Other agents (skill name) |
|------|-------------|---------------------------|
| FE manual TC from story | `/tc-fe-prep` | `tc-fe-prep-workflow` |
| API manual TC from spec + Swagger | `/tc-api-prep` | `tc-api-prep-workflow` |
| Retest a bug after a fix | `/retest-bug` | `retest-bug-workflow` |
| Playwright test for one ticket | `/testing-ticket` | `testing-ticket-workflow` |
| File bugs on Jira or GitHub | `/create-bug` | `create-bug-workflow` |

Append a Jira key or URL when your tool supports it, e.g. `/tc-fe-prep PROJ-123` or “run `retest-bug-workflow` on PROJ-456”.

Full map: [references/skill-routing.md](references/skill-routing.md) · copy-paste prompts: [references/agent-entry.md](references/agent-entry.md)

### Open the Helix menu (optional — when unsure)

| Agent / IDE | How to open the menu |
|-------------|----------------------|
| **Claude Code** | `/helix` |
| **Cursor** | `@helix` or “use skill helix” |
| **Windsurf** | `@helix` |
| **GitHub Copilot** | “Follow the **helix** skill and show the QA menu” |
| **Gemini CLI** | `/skills list` then skill **helix** |
| **Cline** | Select skill **helix** |
| **Codex** | Ask to load skill **helix** |
| **OpenCode / Pi** | Invoke **helix** per tool’s skill UI |

The menu offers options 1–6 (TC FE, TC API, retest, testing ticket, create bug, other) and routes to the same workflows as the table above.

### First run tips

- Workflows auto-load **`references/*-guide.md`** in your repo when present ([workspace-guide-discovery.md](references/workspace-guide-discovery.md)) — fewer repeated questions.
- Long sessions may write **`references/helix-handoff-{KEY}.md`** so you can resume in a new chat ([session-closing.md](references/session-closing.md)).
- Menus and questions are **English only** — [references/user-communication.md](references/user-communication.md). Jira/Sheet content may follow your project language after you approve.
- Non–Claude Code agents: read [AGENTS.md](AGENTS.md) if the tool loads repo-level agent instructions.

## Update (when a new version ships)

Releases: [github.com/Thitic9203/helix/releases](https://github.com/Thitic9203/helix/releases) (tagged on every `main` push that bumps [VERSION](VERSION)).

### Default: auto-update (recommended)

After a **one-time** [install](#install-one-time), you usually **do not** run `git pull` yourself. When we publish a new version on `main`, your machine catches up on the **next agent session** (throttled to at most once every **4 hours**):

| Trigger | What runs |
|---------|-----------|
| New **Claude Code** session (`helix@helix` enabled) | [hooks/session-start](hooks/session-start) → [scripts/helix-auto-update.sh](scripts/helix-auto-update.sh) |
| New **Cursor** session (Helix hooks active) | same |
| You run `git pull` in `~/.helix/tc-fe-prep` | [scripts/hooks/post-merge](scripts/hooks/post-merge) → refresh symlinks + [claude-plugin-sync](scripts/claude-plugin-sync.sh) |

**Auto-update steps (when `VERSION` on GitHub is newer):**

1. `git pull --ff-only` in `~/.helix/tc-fe-prep` (skill symlinks pick up new `SKILL.md` immediately)
2. `link-skills.sh` (refresh global + optional workspace symlinks)
3. `claude plugin update helix@helix` (Claude Code marketplace plugin + hooks)

Log file: `~/.helix/auto-update.log` · Doctor: [helix-doctor.sh](scripts/helix-doctor.sh)

| Opt out / tune | Environment variable |
|----------------|----------------------|
| Disable auto-update | `HELIX_AUTO_UPDATE=0` |
| Force check now | `HELIX_FORCE_UPDATE=1` |
| Check interval (seconds) | `HELIX_AUTO_UPDATE_INTERVAL_SEC` (default `14400` = 4h) |
| Print progress to terminal | `HELIX_AUTO_UPDATE_VERBOSE=1` |

```bash
# Manual check (same as the hook, useful for debugging)
HELIX_FORCE_UPDATE=1 HELIX_AUTO_UPDATE_VERBOSE=1 bash ~/.helix/tc-fe-prep/scripts/helix-auto-update.sh
```

**Notes**

- Needs **network** when the session starts; offline → skip (no error).
- **Cursor / Copilot / Codex / …** — skills update via symlinks after pull; **Reload window** (Cursor) if the agent still shows old skill text.
- **Claude Code** — after a plugin version jump, **start a new session** once if `/helix` or slash commands look stale (skills via `~/.claude/skills` are usually current sooner).

### Claude Code plugin id

| Plugin | Status |
|--------|--------|
| **`helix@helix`** | Canonical — install/update/enable (installer + auto-update) |
| **`helix@local`** | Legacy — **disabled** automatically (do not enable; uninstall can break `helix@helix`) |

`install.sh` and `claude-plugin-sync.sh` keep the marketplace plugin aligned with [VERSION](VERSION).

### Manual update (fallback)

Use if auto-update is off, you deleted `~/.helix/tc-fe-prep`, or you want to force sync now:

```bash
cd ~/.helix/tc-fe-prep && git pull
bash ~/.helix/tc-fe-prep/scripts/claude-plugin-sync.sh # Claude Code: helix@helix
bash ~/.helix/tc-fe-prep/scripts/link-skills.sh # if symlinks missing
```

Or re-run the full installer:

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

### By agent (when something still looks old)

| Agent / IDE | Usually enough | Re-run only if… |
|-------------|----------------|-----------------|
| **Claude Code** | Open a **new session** (auto-update) | `/helix` still old → `bash ~/.helix/tc-fe-prep/scripts/claude-plugin-sync.sh` or full `install.sh` |
| **Cursor** | New session + Reload Window | Skills missing → `link-skills.sh` |
| **Codex / Copilot / Gemini / Windsurf / Cline / Pi** | New session | Symlinks removed → `link-skills.sh` |
| **Team `.github/skills/`** | Auto-update of clone + pull your app repo | New Helix skill added → `HELIX_LINK_WORKSPACE=$PWD …/link-skills.sh` |

### Marketplace-only install (no `~/.helix` clone)

If you only installed **`helix@helix`** from Claude marketplace (never ran `curl …/install.sh`):

- **Plugin + hooks** can still update via SessionStart → `claude-plugin-sync.sh`
- **Global skills** (`~/.cursor/skills`, etc.) need **`install.sh` once** so symlinks point at `~/.helix/tc-fe-prep`

Current release: **README version line above** or [Releases](https://github.com/Thitic9203/helix/releases).

Manual install (contributors)

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

**Fewer agent questions while developing Helix** (optional). Opening the repo in
Claude Code already gives you read-only command allows + context hooks (committed
`.claude/settings.json`). For the fuller global config (`acceptEdits`, wider safe
allowlist, "bias toward action" rules in `~/.claude/CLAUDE.md`):

```bash
bash scripts/helix-setup-devenv.sh # opt-in, idempotent, backs up first
bash scripts/helix-setup-devenv.sh --uninstall # revert (keeps your own rules)
```

Idempotent and re-synced by auto-update once opted in. Requires `jq`.
Details: [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md#dev-environment--fewer-agent-questions-two-layers).

## Skills

| Skill | Description |
|-------|-------------|
| [helix](skills/helix/SKILL.md) | Router menu (agents without `/helix`) |
| [tc-fe-prep-workflow](skills/deprecated/tc-fe-prep-workflow/WORKFLOW.md) | FE manual TC from story AC/EC |
| [tc-api-prep-workflow](skills/deprecated/tc-api-prep-workflow/WORKFLOW.md) | API manual TC from spec + Swagger |
| [retest-bug-workflow](skills/deprecated/retest-bug-workflow/WORKFLOW.md) | Bug retest with evidence |
| [testing-ticket-workflow](skills/deprecated/testing-ticket-workflow/WORKFLOW.md) | Playwright ticket test + optional result update |
| [create-bug-workflow](skills/deprecated/create-bug-workflow/WORKFLOW.md) | File bugs on Jira/GitHub |

## Prerequisites (human)

- Jira access to the issues you name
- Browser logged into Jira when posting large comments or UI retests
- Optional workspace guides: `references/*-tc-fe-prep-guide.md`, `*-retest-guide.md`, `*-testing-ticket-guide.md`

## Docs

| Doc | Purpose |
|-----|---------|
| [docs/supported-agents.md](docs/supported-agents.md) | Paths, capabilities, limitations |
| [references/agent-entry.md](references/agent-entry.md) | Per-agent start prompts |
| [docs/DOC-MAP.md](docs/DOC-MAP.md) | Where each topic lives |
| [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) | Version bump, hooks, releases |
| [docs/wiki/Home.md](docs/wiki/Home.md) | Wiki entry (mirror to GitHub Wiki) |
| [CONTEXT.md](CONTEXT.md) | Domain glossary |

## Scripts

| Script | Purpose |
|--------|---------|
| [install.sh](scripts/install.sh) | One-time setup: clone, symlinks, `helix@helix`, hooks |
| [helix-auto-update.sh](scripts/helix-auto-update.sh) | Check GitHub `VERSION`, pull, sync (SessionStart / manual) |
| [claude-plugin-sync.sh](scripts/claude-plugin-sync.sh) | Update/enable `helix@helix`, disable `helix@local` |
| [helix-doctor.sh](scripts/helix-doctor.sh) | Health check; `HELIX_DOCTOR_FIX=1` to repair |
| [link-skills.sh](scripts/link-skills.sh) | Refresh global + workspace skill symlinks |

Contributor: `bump-version.sh`, `sync-version.sh --check`, `list-skills.sh`, `helix-regression-check.sh` (pre-merge gate), `helix-setup-devenv.sh` (opt-in: fewer agent questions)

## License

MIT — [LICENSE](LICENSE)