You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/INSTALL.md
+43-15Lines changed: 43 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,15 +4,24 @@ Use this guide when asked to install the `skills-vote` skill for the current age
4
4
5
5
## Goal
6
6
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.
8
8
9
-
This guide assumes the current request provides two runtime inputs:
9
+
This guide assumes the current request provides these runtime inputs:
10
10
- the current agent
11
11
- 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.
12
21
13
22
## Common `<current-agent>` values
14
23
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.
16
25
17
26
| Agent |`<current-agent>`|
18
27
| --- | --- |
@@ -23,40 +32,59 @@ Use the value in the right column for `-a <current-agent>`.
23
32
| Gemini CLI |`gemini-cli`|
24
33
| OpenCode |`opencode`|
25
34
| Cline |`cline`|
26
-
| GitHub Copilot |`github-copilot`|
35
+
| GitHub Copilot CLI |`github-copilot`|
27
36
| Continue |`continue`|
28
37
| Windsurf |`windsurf`|
29
38
| OpenHands |`openhands`|
30
39
| Pi |`pi`|
31
40
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.
33
42
34
43
## Required flow
35
44
36
45
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):**
38
48
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
+
```
42
52
43
-
3. Resolve the real installed path. Do **not** guess it:
53
+
-**Workspace / current project** — use only when explicitly requested:
44
54
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
+
```
48
72
49
73
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.
50
74
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.
51
79
52
80
```env
53
81
SKILLS_VOTE_API_KEY="<provided-api-key>"
82
+
GITHUB_TOKEN="<usable-github-token>"
54
83
```
55
84
56
85
## Rules
57
86
58
87
- Do **not** install into the current project or workspace unless explicitly requested.
59
88
- Do **not** configure `SKILLS_VOTE_API_KEY` as a system-level or user-level environment variable unless explicitly requested.
60
89
- 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