Terminal
Terminal/Skill
Turn a sample document into a running Milvus / Zilliz Cloud search app in minutes. Guide the user through Collect → Configure → Plan → Execute and start a local search UI.
By Zilliz (Milvus)
Works with
npx skills add zilliztech/zilliz-launchpad --skill zilliz-launchpadYou are running the zilliz-launchpad skill. Your job is to take a user from "I have some documents I want to search" to "a working local search UI on Milvus / Zilliz Cloud" with as little friction as possible.
The skill has four phases for the MVP (Phases 5 and 6 are future work):
Every imperative action goes through the CLI scripts/zilliz_ops.py. Phases write outputs into scripts/runs/<utc-iso>/.
Do not start a phase before the previous one has produced its artifact. If a phase exits non-zero, surface the error and stop. Each phase can be rerun — the CLI is idempotent.
| Phase | CLI subcommand | Required input | Output file |
|---|---|---|---|
| 1 Collect | collect | --sample <name> or --input <path> | collect.json |
| 2 Configure | configure | --from-json <file> or flags | configure.json |
| 3 Plan | plan | run dir with collect + configure | plan.json, plan.md |
| 4 Execute | execute | run dir with plan | execute.json (+ live Milvus + running sidecar) |
Check the basics:
If the user is going local for the first time, bring Milvus up:
cd skills/zilliz-launchpad/scripts
./start_milvus.sh up
Resolve secrets from env first. Only if a variable is missing and needed by the current phase, prompt the user in dialogue and re-invoke with it exported. Typical variables:
OPENAI_API_KEY — OpenAI embeddings / rerankerVOYAGE_API_KEY — Voyage embeddingsCOHERE_API_KEY — Cohere embeddings / rerankZILLIZ_TOKEN — Zilliz Cloud authenticationZILLIZ_BYOM_URL, ZILLIZ_BYOM_KEY — Zilliz BYOM endpointWhen the CLI fails with {"code":"missing_credential",...}, the payload includes the variable name and an export_hint. Use that hint verbatim when asking the user.
zilliz CLIInstall the zilliz CLI (≥ 0.3.0) to unlock three Cloud-only enhancements. The CLI is never required for local Milvus.
| Phase | With zilliz on PATH | Without |
|---|---|---|
| 2 Configure | zilliz cluster list → pick a cluster; writes cluster_id to configure.json | prompt for URI + token |
| 4 Execute pre-flight | zilliz cluster describe gates on RUNNING; fails fast with cluster_not_ready | skipped |
| 4 Execute bulk | zilliz import create for corpora above bulk_import_threshold (default 100k) | client-side upsert |
| 2/4 Token fallback | zilliz auth whoami returns a scoped token when ZILLIZ_TOKEN is unset | missing_credential |
| 6 Deploy (future) | zilliz cluster create will be wired here | n/a — Deploy requires the CLI |
Load only the references you need for the current phase. Do not prefetch all of references/ — that wastes context.
| Phase | Load from references/ |
|---|---|
| 1 Collect | knowledge/document_processing.md |
| 2 Configure | knowledge/rag_templates.md, deploy-*.md (match the user's target) |
| 3 Plan | knowledge/dense_embedding_models.md, knowledge/sparse_embedding_models.md, knowledge/index_tuning.md, knowledge/schema_design.md, knowledge/hybrid_search_guide.md, knowledge/reranker_guide.md |
| 4 Execute | cli-reference.md |
observability/ is Phase 6 (Deploy) territory — do not load in MVP.
Assume the working directory is the repo root.
# Phase 1 — sample data (or --input your.jsonl)
uv run python skills/zilliz-launchpad/scripts/zilliz_ops.py collect --sample movies
# Phase 2 — take defaults with overrides
uv run python skills/zilliz-launchpad/scripts/zilliz_ops.py configure \
--use-case rag --dataset-size 20 --deployment local-standalone
# Phase 3
uv run python skills/zilliz-launchpad/scripts/zilliz_ops.py plan
# Phase 4
uv run python skills/zilliz-launchpad/scripts/zilliz_ops.py execute --sample movies
On success of Phase 4, start the demo UI:
cd skills/zilliz-launchpad/scripts/ui
npm install
npm run dev
# open http://localhost:3000
Every CLI error arrives on stderr as a single-line JSON object:
{"code": "missing_credential", "message": "...", "env_var": "OPENAI_API_KEY", "export_hint": "export OPENAI_API_KEY=..."}
Known codes and how to react:
| code | action |
|---|---|
missing_credential | prompt the user for the value; ask them to export it; retry |
schema_conflict | a collection exists with a different schema; offer to drop or to rename the plan's collection_name |
sparse_unavailable | the user picked hybrid/sparse but the collection was built without sparse; offer to rebuild |
invalid_profile | Phase 3 got a malformed input; go back to Configure |
backend_unsupported | requested index (e.g. DiskANN) isn't available on the target; pick a fallback from index_tuning.md |
zilliz_cli_missing | a Cloud-only feature needs zilliz; point at install_url in the payload |
zilliz_cli_auth | CLI present but not logged in; tell the user to run zilliz auth login |
cluster_not_ready | pre-flight found a non-RUNNING cluster; surface state + remediation verbatim |
lib/)If the user asks for any of the above, politely say it's on the roadmap and keep scope tight.
Be concrete. When the user asks an open question (e.g., "should I use HNSW or DiskANN?"), consult the relevant reference in knowledge/, state a recommendation with one-line reasoning, and proceed. Don't pile up options without a pick.