Skip to content

Commit 6136dbc

Browse files
fix: update install instruction
1 parent 1f1b221 commit 6136dbc

2 files changed

Lines changed: 47 additions & 18 deletions

File tree

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,10 +73,11 @@ For a detailed breakdown of the quality and verifiability criteria used in our e
7373
Supercharge your agents (Codex, Claude Code, OpenClaw) by integrating SkillsVote directly! Just drop this prompt into your agent:
7474

7575
```markdown
76-
1. Install the skill by running `npx skills add MemTensor/skills-vote --skill skills-vote`
77-
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"`
76+
Fetch and follow installation instructions from https://raw.githubusercontent.com/MemTensor/skills-vote/main/docs/INSTALL.md
7877

79-
Do not configure this as a system or user-level environment variable unless explicitly requested.
78+
Use the following values:
79+
`SKILLS_VOTE_API_KEY`: `YOUR_API_KEY`
80+
`GITHUB_TOKEN`:`YOUR_GH_TOKEN`
8081
```
8182

8283
#### 🔧 Manual Setup Alternative

docs/INSTALL.md

Lines changed: 43 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,24 @@ Use this guide when asked to install the `skills-vote` skill for the current age
44

55
## Goal
66

7-
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.
7+
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.
88

9-
This guide assumes the current request provides two runtime inputs:
9+
This guide assumes the current request provides these runtime inputs:
1010
- the current agent
1111
- the API key value to write into `.env`
12+
- optionally, a usable GitHub token if one is already available or explicitly provided
13+
14+
## Installation scope
15+
16+
Support both installation scopes:
17+
- **Global**: default choice
18+
- **Workspace / current project**: use only when the current request explicitly asks for it
19+
20+
If the intended scope is unclear, stop and ask instead of guessing.
1221

1322
## Common `<current-agent>` values
1423

15-
Use the value in the right column for `-a <current-agent>`.
24+
Use the value in the right column for `-a <current-agent>`. These are `npx skills` agent identifiers, not generic product labels.
1625

1726
| Agent | `<current-agent>` |
1827
| --- | --- |
@@ -23,40 +32,59 @@ Use the value in the right column for `-a <current-agent>`.
2332
| Gemini CLI | `gemini-cli` |
2433
| OpenCode | `opencode` |
2534
| Cline | `cline` |
26-
| GitHub Copilot | `github-copilot` |
35+
| GitHub Copilot CLI | `github-copilot` |
2736
| Continue | `continue` |
2837
| Windsurf | `windsurf` |
2938
| OpenHands | `openhands` |
3039
| Pi | `pi` |
3140

32-
If the current agent is not listed here, use the exact agent value accepted by `npx skills add -a ...`.
41+
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.
3342

3443
## Required flow
3544

3645
1. Determine the current agent and set `<current-agent>` accordingly. If you cannot determine the current agent reliably, stop and ask instead of guessing.
37-
2. Install the skill globally:
46+
2. Determine the installation scope:
47+
- **Global (default):**
3848

39-
```bash
40-
npx skills add MemTensor/skills-vote -g -a <current-agent> -s skills-vote -y
41-
```
49+
```bash
50+
npx skills add MemTensor/skills-vote -g -a <current-agent> -s skills-vote -y
51+
```
4252

43-
3. Resolve the real installed path. Do **not** guess it:
53+
- **Workspace / current project** — use only when explicitly requested:
4454

45-
```bash
46-
npx skills list -g -a <current-agent> --json
47-
```
55+
```bash
56+
npx skills add MemTensor/skills-vote -a <current-agent> -s skills-vote -y
57+
```
58+
59+
3. Resolve the real installed path with the matching scope. Do **not** guess it:
60+
61+
- **Global:**
62+
63+
```bash
64+
npx skills list -g -a <current-agent> --json
65+
```
66+
67+
- **Workspace / current project:**
68+
69+
```bash
70+
npx skills list -a <current-agent> --json
71+
```
4872

4973
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.
5074
5. Create or update `<path>/.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`.
75+
6. GitHub token handling is optional:
76+
- If a usable `GH_TOKEN` or `GITHUB_TOKEN` is already available or explicitly provided, you may write one of them into `<path>/.env`.
77+
- 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.
78+
- If no usable GitHub token is ultimately provided, do **not** set `GH_TOKEN` or `GITHUB_TOKEN` in the `.env` file.
5179

5280
```env
5381
SKILLS_VOTE_API_KEY="<provided-api-key>"
82+
GITHUB_TOKEN="<usable-github-token>"
5483
```
5584

5685
## Rules
5786

5887
- Do **not** install into the current project or workspace unless explicitly requested.
5988
- Do **not** configure `SKILLS_VOTE_API_KEY` as a system-level or user-level environment variable unless explicitly requested.
6089
- Do **not** hardcode the install path. Always use the path returned by `npx skills list ... --json`.
61-
- 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.
62-
90+
- 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.

0 commit comments

Comments
 (0)