菜单
Guide a brand-new SearchCLI/vs user from first-time usage questions to sign-up, purchase of Viking AI Search, AK/SK setup, and a working authenticated CLI. Use when the user says they downloaded or installed SearchCLI/vs and asks how to use it, how to start, sign up, buy, or onboard.
默认使用会先检查来源的 Prompt；你也可以切换为直接命令，或下载本地副本。
决定是否安装前，请先阅读 SKILL.md，以及 SkillsMP 当前展示的配套文件。
用 Codex 或 Claude 帮你安装 复制这段 Prompt，粘贴到 Codex、Claude 或其他助手里，让它检查 Skill 页面并帮你完成安装。
直接命令不会经过审查 Prompt；运行前请先检查来源。
npx skills add https://github.com/volcengine/SearchCLI --skill vs-user-onboarding命令会保持在同一行。复制前请横向滚动并检查完整内容。
想先保存到本地？可下载 SkillsMP 当前能够提供的文件。
正在显示 SKILL.md
| name | vs-user-onboarding |
| title | vs-user-onboarding |
| description | Guide a brand-new SearchCLI/vs user from first-time usage questions to sign-up, purchase of Viking AI Search, AK/SK setup, and a working authenticated CLI. Use when the user says they downloaded or installed SearchCLI/vs and asks how to use it, how to start, sign up, buy, or onboard. |
| category | workflow |
| applies_to | codex, agents, external-agent |
| requires_cli | >=0.2.0 |
| keywords | new user onboarding, sign up, register, purchase, buy, real-name verification, access key, ak sk, first run, first-time setup, get started, how to use, downloaded searchcli, installed searchcli, searchcli setup, vs setup, just installed vs, viking ai search |
| commands | auth status, auth login, auth import-env, doctor, skill list, skill show, purchase link, purchase order status, purchase order wait |
Use this skill when the agent detects that a user needs to complete AI Search purchase / order placement, recover from a missing-auth CLI error, configure local AK/SK, or start using SearchCLI/vs for the first time before continuing with later Viking AI Search workflows.
Common trigger phrases include:
The agent must route the user to the right entry point, guide the user through the console purchase page when needed, wait for explicit purchase completion, handle the root-account/sub-account key checkpoint, and then guide AK/SK creation or local CLI readiness. Order visibility checks are available only when local AK/SK already exists.
Choose one entry path before running the workflow, but always start the skill by running vs auth status --json so returning users are not forced through registration again.
| Entry path | Trigger | Start point |
|---|---|---|
| New-user purchase | The user asks to place an order, purchase, activate, open AI Search, or says they are in a new-user registration conversion flow | Step 1, then Step 2 or Step 3 based on auth status |
| Purchased but not configured | The user says they have purchased and needs AK/SK or local CLI setup | Step 5 |
| Missing-auth CLI recovery | A credential-required command fails with the CLI recovery message below | Use the recovery routing rules, then continue at Step 2, Step 5, or Step 6 |
Credential-required commands include product and runtime commands such as vs item ..., vs search run, vs app ..., vs dataset ..., vs recommend ..., and vs purchase order wait.
The CLI missing-auth recovery message is:
You are not authenticated. To get started:
- If you already have AK/SK: run `vs auth login` or `vs auth import-env`.
- If you are new to Viking AI Search: run `vs skill show vs-user-onboarding`.
Recovery routing:
vs auth login or , then continue at Step 6.vs auth import-envvs CLI is installed. Purchase link retrieval does not require local AK/SK authentication. Order visibility checks require configured local AK/SK and are optional for this workflow unless the user already has credentials.purchase link: print the onboarding purchase page link for the user's selected environment.purchase order status: check once whether the onboarding purchase order or billing instance is visible; requires local AK/SK.purchase order wait: wait until the onboarding purchase order is visible; requires local AK/SK and retries every 2 seconds, up to 5 attempts.auth status: inspect local auth and, when AK/SK exists, classify readiness through the purchase order status path.doctor: inspect local CLI environment if command execution fails before reaching the service.Always run vs auth status --json first and inspect the result. In CLI versions that expose structured status, this command first checks whether local AK/SK is configured; when AK/SK exists, it uses the same backend path as vs purchase order status to verify that the Viking AI Search billing instance is visible and healthy.
status: "ok") -> run vs doctor --json; if it passes, go directly to Step 8 (early exit; do not force a returning user through registration again). A post-paid instance (including the free post-paid tier) also reports as enabled here, so do not push a post-paid user back through the purchase flow.reason: "unconfigured" -> go to Step 2; if the user already has AK/SK, Step 2 routes to Step 6.reason: "invalid" -> go to Step 6 and ask the user to reconfigure valid AK/SK.reason: "product-not-enabled" -> go to Step 3 because credentials may be valid but purchase order status cannot confirm a visible, enabled billing instance.reason: "network-error" -> ask the user to fix connectivity or endpoint configuration before continuing; do not start registration unless the user confirms they are a new buyer.If the CLI version exposes structured failure reasons (
unconfigured,invalid,product-not-enabled,network-error), use them to skip steps where possible (e.g.,product-not-enabled→ skip account registration and jump to Step 3 with the purchase-page deeplink). If the CLI only reports "authenticated / not authenticated", proceed to Step 2's question.
Present this exact table to the user and ask them to pick one option. Do not show the internal next-step routing to the user.
| Option | Your state |
|---|---|
| A | I don't have a Volcengine account yet |
| B | I have an account but haven't purchased Viking AI Search |
| C | I've already purchased; I need to get my AK/SK |
| D | I already have AK/SK, just need to configure the CLI |
Internal routing after the user answers:
Confirmation contract: the user must reply with the option letter or its plain equivalent ("A", "option A", "I don't have an account"). Free-text replies that don't clearly map to an option require re-asking. If the user is unsure ("I'm not sure if I bought it"), conservatively pick the earlier option (treat "not sure if bought" as B, not C).
volcano-cn-beijingvolcano-ap-southeast-1byteplus-ap-southeast-1vs purchase link --environment-id <environment-id> and show the returned purchase page link.On the order page, complete: choose edition -> real-name verification (opened in-page; skipped if already verified) -> payment. Pay attention to the project selector on the order page; it usually defaults to default. After finishing, reply that the purchase is complete.
Use the term 项目 instead of project when the user's latest message is Chinese.purchase completed, payment completed, order placed, or activation completed.ok, opened, I will check, or I am on the page as purchase completion.项目 when the user's latest message is Chinese; otherwise use project.defaultdefault, or leaves the free-text answer empty, set <project-name> to default.<project-name> for later order checks and local verification.This is an optional enhancement when local AK/SK already exists. It is not the gate for a brand-new user to proceed to AK/SK creation. If Step 1 already returned status: "ok", the order/billing instance has already been verified through the purchase order status path and this check can be skipped unless the user asks for an explicit wait.
status: "ok".vs purchase order wait --project-name <project-name> --max-attempts 5 --poll-interval-ms 2000Ask the user this exact question: Are you signed in as a root account or a sub-account?
https://console.volcengine.com/iam/keymanage, then ask the user to create or retrieve AK/SK there. Tell the user not to paste AK/SK into chat.This is a human checkpoint. The agent must wait for explicit confirmation that the user has AK/SK available before moving to Step 6.
Use only the supported CLI credential flows. Never ask the user to paste AK/SK into chat.
<project-name> is default, the command may omit --project-name<project-name> is not default, the command must include --project-name <project-name>VIKING_AK and VIKING_SK are already set in the user's real shell, ask the user to run:
vs auth import-envvs auth import-env --project-name <project-name>vs auth loginvs auth login --project-name <project-name>cn-beijing.ap-southeast-1 (Johor).After credentials are imported, run vs auth status --json --project-name <project-name> and vs doctor --json --project-name <project-name>.
vs auth status --json --project-name <project-name> reports unconfigured or invalid, return to Step 6.product-not-enabled, return to Step 3 and ask the user to confirm purchase/opening status.network-error, ask the user to fix connectivity or endpoint settings and retry Step 7.Tell the user that authentication is complete and they can continue with vs-item-onboarding for data ingestion and their first search experience. End this workflow after the handoff.
purchase order wait --project-name <project-name> exists so the agent can wait for order visibility when local AK/SK is already configured but vs auth status --json --project-name <project-name> still reports product-not-enabled.purchase order wait retries every 2 seconds.vs ... command in this onboarding and purchase workflow, first consult vs-product-qa to verify the current command surface, required flags, payload fields, input format, and allowed values. Only after that check may you finalize parameters and run the command.vs auth status --json; if it reports authenticated and vs doctor --json passes, early-exit to Step 8.purchase order status or purchase order wait without local AK/SK authentication.ok, opened, I see it, or I entered the page as purchase completion.vs auth import-env or vs auth login.vs purchase link --environment-id <environment-id>; do not hardcode the URL in the skill workflow or agent response.volcano-cn-beijing, volcano-ap-southeast-1, and byteplus-ap-southeast-1.vs-product-qa; after that answer, return to this workflow only if the user still wants to continue purchasing.