AgentKit
Tài liệuBộ kitTham chiếu CLIỨng dụng Desktop

Skill

Tạo showcase artifact với ak:show-off

Plan, research, design, review, capture và tùy chọn publish một presentation độc lập trong khi kiểm soát workflow preference bền vững.

Dùng ak:show-off để biến prompt hoặc Markdown brief thành HTML showcase độc lập, chỉn chu với cited content cùng section image tùy chọn. Workflow lưu screenshot, publication và language preference, tạo durable plan và có thể publish ra ngoài, vì vậy hãy resolve các control đó trước khi phân tích mission.

Chọn ak:show-off cho presentation artifact

Dùng ak:show-off khi

  • Bạn cần scrollable demo, visual presentation hoặc social-ready showcase.
  • Work phù hợp với hai đến sáu designed section cùng hero mạnh.
  • Bạn muốn section capture responsive ở 16:9, 9:16 và 1:1.
  • Bạn cần output song ngữ Việt-Anh hoặc một supported language.

Chọn workflow khác khi

  • Bạn cần reusable application hoặc product surface thay vì showcase.
  • Bạn chỉ cần prose hoặc standard document không có HTML presentation design.
  • Material chứa credential, private data hoặc content không thể research, render hay publish an toàn.
  • Bạn không thể duyệt plan artifact. Tạo plan là hard prerequisite.

Resolve preference và prerequisite

User-level default có effect đáng kể:

PreferenceMặc địnhEffect
screenshotstrueChạy browser capture cho mọi section và ratio đã chọn
publishingtruePublish content cùng static site hoàn tất qua agentwiki
languagesvi,enTạo content song ngữ với toggle hoặc parallel treatment

Preference được lưu tại $AGENTKIT_HOME/show-off/preferences.json, fallback về ~/.agentkit/show-off/preferences.json. SHOW_OFF_PREFS_PATH có thể override tệp cho test hoặc one-off advanced setup.

Trước khi bắt đầu:

  • Hoàn thành Làm quen và xác nhận Engineer Kit cùng design và project-management Skill được kế thừa đã cài.
  • Bảo đảm Node.js 18 trở lên khả dụng.
  • Cho local capture, cung cấp Puppeteer cùng Chrome hoặc Chromium binary dùng được; Sharp được dùng khi khả dụng để nén image quá lớn.
  • Quyết định internet research, public publication cùng screenshot capture có được phép cho mission này hay không.
  • Loại secret và xác nhận quyền publish content cùng asset được cung cấp.
RuntimeCách gọiRanh giới khả dụng
Claude Code/ak:show-off ...Phân phối native là mặc định. Workflow có thể dùng đầy đủ Engineer planning cùng browser-oriented toolchain khi đã cài.
Cursor/ak:show-off ...Cách gọi bằng slash đã được người dùng xác minh; parity về nested Skill, browser cùng publication chưa được bằng chứng đó thiết lập.
Codex$ak:show-off ...Native discovery áp dụng cho main Skill. Nested planning/design call cùng browser automation phụ thuộc projected capability và có thể cần runtime-native adaptation.

Yêu cầu showcase có boundary

Nêu mission, audience, evidence standard, publication boundary, screenshot choice cùng language. Thêm “for this run only” khi override không được persist.

/ak:show-off "Create an English-only launch demo from release-notes.md. Local only, no screenshots, for this run only. Cite every external claim and open the final HTML for review."
Control intentHành vi được resolve
--no-screenshotsBỏ local và remote capture, đánh capture skipped, báo local HTML
--no-publish hoặc “local only”Bỏ cả document cùng static-site publication
--languages en, --languages vi hoặc bilingual intentChọn English, Vietnamese hoặc vi,en
Reset intentXóa stored preference file và trở về default
“For this run only”Áp dụng override mà không persist

Nếu không có one-run qualifier, explicit preference change được lưu ngay. Latest explicit instruction override stored state.

Hiểu điều gì xảy ra trong một lần chạy

  1. Skill resolve workflow control. Trước khi đọc mission, Skill tải persisted preference và áp dụng explicit override.
  2. Skill tạo durable planning state. ak:project-management tạo dated directory dưới plans/, đăng ký task request-analysis, content, HTML, review, capture và publish phù hợp, rồi ghi argument cùng preference.
  3. Skill research mission. Workflow search internet để hỗ trợ và fact-check, rồi ghi cited section content vào assets/showoff/<mission-name>/content.md.
  4. Skill tùy chọn publish document. Khi publication vẫn enabled, agentwiki tổ chức hoặc tạo destination rồi publish content.
  5. Skill design showcase. ak:frontend-design tạo self-contained HTML presentation với hai đến sáu section, responsive composition, theme control, citation cùng font hỗ trợ tiếng Việt khi cần.
  6. Skill capture enabled output. Local script khởi chạy Puppeteer, chờ network idle, font, image, CSS background, layout frame cùng settle delay, rồi capture mỗi section ở mọi selected ratio.
  7. Skill dùng conditional remote fallback. Chỉ khi publication enabled, local capture fail, có rwsRWEB_API_KEY, workflow mới có thể capture public page qua ReviewWeb.
  8. Skill publish và mở kết quả. Khi enabled, Skill update static site; trong mọi flow Skill mở local HTML hoặc báo vì sao không thể.
  9. Skill đối chiếu plan. Mỗi task được update khi bắt đầu, hoàn tất hoặc được intentionally skip.

Với hai đến sáu section và ba default ratio, capture có thể tạo sáu đến mười tám high-resolution image. Mỗi readiness signal được bound bởi render timeout mặc định 15 giây, cộng settle delay mặc định 1,5 giây mỗi readiness pass; remote asset cùng animation có thể kéo dài tổng thời gian.

Giữ publication và capture dưới control rõ ràng

Stored default không phải publication approval

publishing: true là workflow preference, không phải bằng chứng rằng public destination, audience, credential hoặc cost mới đã được duyệt. Xác nhận exact publication action trước khi dùng agentwiki hoặc ReviewWeb.

  • Internet research gửi search query và nhận external content. Đừng đưa private mission data vào query.
  • agentwiki mutate external content destination. Publication có thể expose content và làm HTML public reachable.
  • ReviewWeb gửi public URL tới external screenshot provider và cần RWEB_API_KEY. Key phải ở environment và không được xuất hiện trong command hoặc generated HTML.
  • Local Puppeteer khởi động browser process, có thể tải remote page asset và ghi image file. Dừng failed hoặc orphaned browser process.
  • Preference write, plan file, content Markdown, HTML cùng image là durable disk effect. Review path cùng size trước khi giữ.
  • Workflow không cấp quyền authentication work, database access, source deployment, commit, push hoặc xử lý sensitive data.

Xác minh kết quả

Một lần chạy hoàn tất nên cung cấp:

  • Plan có resolved preference cùng task status chính xác.
  • content.md có citation và được tổ chức theo selected section.
  • Self-contained HTML artifact với hero mạnh, system/light/dark theme control, responsive layout cùng language treatment đúng.
  • Khi enabled, image được đặt tên theo ratio và section dưới assets/showoff/<mission-name>/images/.
  • Capture JSON liệt kê file thành công, size, compression state cùng lỗi.
  • Local review path và chỉ khi được duyệt rõ mới có public destination.

Xác minh ở 16:9, 9:16 cùng 1:1; kiểm tra content không bị clip, Vietnamese diacritic render đúng, control có keyboard-visible state, reduced motion được tôn trọng, citation resolve và không có credential hay private text trong artifact. Package có preference-helper test chạy bằng Node; không có test cho generated design quality hoặc external publication.

Xử lý sự cố hoặc tiếp tục

Triệu chứngBước tiếp theo an toàn
Workflow muốn publish ngoài dự kiếnDừng, đặt --no-publish, xác nhận resolved JSON và dùng one-run override nếu phù hợp.
Persisted opt-out bị bỏ quaĐọc resolved preference path và bảo đảm request sau không override nó.
Project management bị blockResolve missing plan context; không tiếp tục content hay HTML work.
Puppeteer hoặc Chrome unavailableGiữ publication off và báo local capture error; đừng dùng remote fallback cho local-only run.
rws báo auth error hoặc thiếu keyDừng và báo; đừng âm thầm skip required capture hay expose key.
Section thiếu trong captureXác nhận selector cùng visible layout, rồi chỉ chạy lại affected ratio.
Image vượt storage budgetGiảm section hoặc ratio và kiểm tra Sharp compression có khả dụng không.
External claim thiếu citationGiữ artifact local tới khi mọi claim được hỗ trợ hoặc loại bỏ.
Runtime không nhận diện SkillXác nhận target cùng scope, mở runtime session mới, rồi làm theo Runtime không tìm thấy Skill hoặc Agent.

Biết các giới hạn hiện tại

  • Default workflow giả định web search, bilingual output, screenshot cùng publication; dùng explicit opt-out cho run nhỏ hoặc private.
  • Capture cần local browser dependency hoặc published remote fallback đủ điều kiện.
  • License field trỏ tới LICENSE.txt, nhưng tệp đó vắng trong cả hai exact package. Xác nhận distribution term trước khi redistribute Skill asset.
  • Package stable và beta hiện chứa cùng ak:show-off, preference, capture cùng preference-test file.