From 1f1b2213d11733d845ebcae6c62fdf59e8cafe70 Mon Sep 17 00:00:00 2001 From: shiuing Date: Thu, 9 Apr 2026 16:52:34 +0800 Subject: [PATCH 1/2] feat: add agentic install instruction --- docs/INSTALL.md | 62 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 62 insertions(+) create mode 100644 docs/INSTALL.md diff --git a/docs/INSTALL.md b/docs/INSTALL.md new file mode 100644 index 0000000..6788831 --- /dev/null +++ b/docs/INSTALL.md @@ -0,0 +1,62 @@ +# Install SkillsVote + +Use this guide when asked to install the `skills-vote` skill for the current agent. + +## Goal + +Install `skills-vote` into the current agent's **global** skill directory, not the current project or workspace. Then write `SKILLS_VOTE_API_KEY` only into the installed skill root. + +This guide assumes the current request provides two runtime inputs: +- the current agent +- the API key value to write into `.env` + +## Common `` values + +Use the value in the right column for `-a `. + +| Agent | `` | +| --- | --- | +| Codex | `codex` | +| Claude Code | `claude-code` | +| OpenClaw | `openclaw` | +| Cursor | `cursor` | +| Gemini CLI | `gemini-cli` | +| OpenCode | `opencode` | +| Cline | `cline` | +| GitHub Copilot | `github-copilot` | +| Continue | `continue` | +| Windsurf | `windsurf` | +| OpenHands | `openhands` | +| Pi | `pi` | + +If the current agent is not listed here, use the exact agent value accepted by `npx skills add -a ...`. + +## Required flow + +1. Determine the current agent and set `` accordingly. If you cannot determine the current agent reliably, stop and ask instead of guessing. +2. Install the skill globally: + +```bash +npx skills add MemTensor/skills-vote -g -a -s skills-vote -y +``` + +3. Resolve the real installed path. Do **not** guess it: + +```bash +npx skills list -g -a --json +``` + +4. Read the returned JSON and find the `path` for `skills-vote`. Treat that path as the skill root. If no valid `path` is returned for `skills-vote`, stop and report the failure instead of guessing. +5. Create or update `/.env` and set `SKILLS_VOTE_API_KEY` to the API key value provided in the current request or prompt. Do not write the literal string `YOUR_API_KEY`. + +```env +SKILLS_VOTE_API_KEY="" +``` + +## Rules + +- Do **not** install into the current project or workspace unless explicitly requested. +- Do **not** configure `SKILLS_VOTE_API_KEY` as a system-level or user-level environment variable unless explicitly requested. +- Do **not** hardcode the install path. Always use the path returned by `npx skills list ... --json`. +- If the current request does not provide a usable API key value, stop and ask your owner to provide one or obtain one from `https://skills.vote`. Do not invent an API key. + From 6136dbc65bf97141b3a28fa838c4bced1095d483 Mon Sep 17 00:00:00 2001 From: shiuing Date: Thu, 9 Apr 2026 17:38:08 +0800 Subject: [PATCH 2/2] fix: update install instruction --- README.md | 7 +++--- docs/INSTALL.md | 58 ++++++++++++++++++++++++++++++++++++------------- 2 files changed, 47 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index a7db47f..d57b425 100644 --- a/README.md +++ b/README.md @@ -73,10 +73,11 @@ For a detailed breakdown of the quality and verifiability criteria used in our e Supercharge your agents (Codex, Claude Code, OpenClaw) by integrating SkillsVote directly! Just drop this prompt into your agent: ```markdown -1. Install the skill by running `npx skills add MemTensor/skills-vote --skill skills-vote` -2. Create or update `.env` file located in the root directory of the installed `skills-vote` skill and set `SKILLS_VOTE_API_KEY="YOUR_API_KEY"` +Fetch and follow installation instructions from https://raw.githubusercontent.com/MemTensor/skills-vote/main/docs/INSTALL.md -Do not configure this as a system or user-level environment variable unless explicitly requested. +Use the following values: +`SKILLS_VOTE_API_KEY`: `YOUR_API_KEY` +`GITHUB_TOKEN`:`YOUR_GH_TOKEN` ``` #### 🔧 Manual Setup Alternative diff --git a/docs/INSTALL.md b/docs/INSTALL.md index 6788831..b721ac8 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -4,15 +4,24 @@ Use this guide when asked to install the `skills-vote` skill for the current age ## Goal -Install `skills-vote` into the current agent's **global** skill directory, not the current project or workspace. Then write `SKILLS_VOTE_API_KEY` only into the installed skill root. +Install `skills-vote` into the current agent's **global** skill directory by default. If the current request explicitly asks for workspace or current-project installation, use that scope instead. Then write `SKILLS_VOTE_API_KEY` and optionally a usable GH_TOKEN or GITHUB_TOKEN only into the installed skill root. -This guide assumes the current request provides two runtime inputs: +This guide assumes the current request provides these runtime inputs: - the current agent - the API key value to write into `.env` +- optionally, a usable GitHub token if one is already available or explicitly provided + +## Installation scope + +Support both installation scopes: +- **Global**: default choice +- **Workspace / current project**: use only when the current request explicitly asks for it + +If the intended scope is unclear, stop and ask instead of guessing. ## Common `` values -Use the value in the right column for `-a `. +Use the value in the right column for `-a `. These are `npx skills` agent identifiers, not generic product labels. | Agent | `` | | --- | --- | @@ -23,34 +32,54 @@ Use the value in the right column for `-a `. | Gemini CLI | `gemini-cli` | | OpenCode | `opencode` | | Cline | `cline` | -| GitHub Copilot | `github-copilot` | +| GitHub Copilot CLI | `github-copilot` | | Continue | `continue` | | Windsurf | `windsurf` | | OpenHands | `openhands` | | Pi | `pi` | -If the current agent is not listed here, use the exact agent value accepted by `npx skills add -a ...`. +If the current agent is not listed here, use the exact agent value accepted by `npx skills add -a ...`. If you are unsure, check `npx skills add --help` instead of guessing. ## Required flow 1. Determine the current agent and set `` accordingly. If you cannot determine the current agent reliably, stop and ask instead of guessing. -2. Install the skill globally: +2. Determine the installation scope: + - **Global (default):** -```bash -npx skills add MemTensor/skills-vote -g -a -s skills-vote -y -``` + ```bash + npx skills add MemTensor/skills-vote -g -a -s skills-vote -y + ``` -3. Resolve the real installed path. Do **not** guess it: + - **Workspace / current project** — use only when explicitly requested: -```bash -npx skills list -g -a --json -``` + ```bash + npx skills add MemTensor/skills-vote -a -s skills-vote -y + ``` + +3. Resolve the real installed path with the matching scope. Do **not** guess it: + + - **Global:** + + ```bash + npx skills list -g -a --json + ``` + + - **Workspace / current project:** + + ```bash + npx skills list -a --json + ``` 4. Read the returned JSON and find the `path` for `skills-vote`. Treat that path as the skill root. If no valid `path` is returned for `skills-vote`, stop and report the failure instead of guessing. 5. Create or update `/.env` and set `SKILLS_VOTE_API_KEY` to the API key value provided in the current request or prompt. Do not write the literal string `YOUR_API_KEY`. +6. GitHub token handling is optional: + - If a usable `GH_TOKEN` or `GITHUB_TOKEN` is already available or explicitly provided, you may write one of them into `/.env`. + - If the GitHub token is empty, missing, or unable to use, warn your owner that downloading skills may hit a GitHub rate limit and ask for a usable token. + - If no usable GitHub token is ultimately provided, do **not** set `GH_TOKEN` or `GITHUB_TOKEN` in the `.env` file. ```env SKILLS_VOTE_API_KEY="" +GITHUB_TOKEN="" ``` ## Rules @@ -58,5 +87,4 @@ SKILLS_VOTE_API_KEY="" - Do **not** install into the current project or workspace unless explicitly requested. - Do **not** configure `SKILLS_VOTE_API_KEY` as a system-level or user-level environment variable unless explicitly requested. - Do **not** hardcode the install path. Always use the path returned by `npx skills list ... --json`. -- If the current request does not provide a usable API key value, stop and ask your owner to provide one or obtain one from `https://skills.vote`. Do not invent an API key. - +- If the current request does not provide a usable API key value, stop and ask your owner to provide one or obtain one from `https://skills.vote`. Do not invent an API key. \ No newline at end of file