-
Notifications
You must be signed in to change notification settings - Fork 4
feat: add agentic install instruction #4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
starsalwaysineyes
wants to merge
2
commits into
main
Choose a base branch
from
docs/install-instruction
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| # 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 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 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 `<current-agent>` values | ||
|
|
||
| Use the value in the right column for `-a <current-agent>`. These are `npx skills` agent identifiers, not generic product labels. | ||
|
|
||
| | Agent | `<current-agent>` | | ||
| | --- | --- | | ||
| | Codex | `codex` | | ||
| | Claude Code | `claude-code` | | ||
| | OpenClaw | `openclaw` | | ||
| | Cursor | `cursor` | | ||
| | Gemini CLI | `gemini-cli` | | ||
| | OpenCode | `opencode` | | ||
| | Cline | `cline` | | ||
| | 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 you are unsure, check `npx skills add --help` instead of guessing. | ||
|
|
||
| ## Required flow | ||
|
|
||
| 1. Determine the current agent and set `<current-agent>` accordingly. If you cannot determine the current agent reliably, stop and ask instead of guessing. | ||
| 2. Determine the installation scope: | ||
| - **Global (default):** | ||
|
|
||
| ```bash | ||
| npx skills add MemTensor/skills-vote -g -a <current-agent> -s skills-vote -y | ||
| ``` | ||
|
|
||
| - **Workspace / current project** — use only when explicitly requested: | ||
|
|
||
| ```bash | ||
| npx skills add MemTensor/skills-vote -a <current-agent> -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 <current-agent> --json | ||
| ``` | ||
|
|
||
| - **Workspace / current project:** | ||
|
|
||
| ```bash | ||
| npx skills list -a <current-agent> --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 `<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`. | ||
| 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 `<path>/.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="<provided-api-key>" | ||
| GITHUB_TOKEN="<usable-github-token>" | ||
| ``` | ||
|
|
||
| ## 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. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.