For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
主要導覽
Codex

Codex use case

建立 Codex 可使用的 CLI

為 Codex 提供可組合使用的指令,用來操作 API、記錄來源、匯出資料或團隊指令碼。

Difficulty 中級
Time horizon 1 小時

請 Codex 建立一個可組合使用的 CLI,讓它能從任何資料夾執行、與程式碼庫指令碼搭配、用來下載檔案,並透過配套技能記住其用法。

最適合

  • 需要 Codex 對同一個服務、匯出資料、本機封存資料或程式碼庫指令碼反覆進行搜尋、讀取、下載或安全寫入的工作。
  • 需要分頁搜尋、依 ID 精確讀取、可預期的 JSON、下載檔案、本機索引,或先草擬再寫入之指令的智慧體工具。

Contents

    ← 所有使用案例

    建立 Codex 可使用的 CLI

    為 Codex 提供可組合使用的指令,用來操作 API、記錄來源、匯出資料或團隊指令碼。

    請 Codex 建立一個可組合使用的 CLI,讓它能從任何資料夾執行、與程式碼庫指令碼搭配、用來下載檔案,並透過配套技能記住其用法。

    中級
    1 小時

    請 Codex 建立一個可組合使用的 CLI,讓它能從任何資料夾執行、與程式碼庫指令碼搭配、用來下載檔案,並透過配套技能記住其用法。

    中級
    1 小時

    最適合

    • 需要 Codex 對同一個服務、匯出資料、本機封存資料或程式碼庫指令碼反覆進行搜尋、讀取、下載或安全寫入的工作。
    • 需要分頁搜尋、依 ID 精確讀取、可預期的 JSON、下載檔案、本機索引,或先草擬再寫入之指令的智慧體工具。

    技能與外掛程式

    • 規劃指令介面、建置 CLI、新增設定與身分驗證檢查、將指令安裝至 PATH,並從另一個資料夾驗證指令。
    • 建立配套技能,讓 Codex 日後執行任務時,知道應先執行哪些 CLI 指令,以及哪些寫入操作需要核准。
    Skill Why use it
    Cli Creator 規劃指令介面、建置 CLI、新增設定與身分驗證檢查、將指令安裝至 PATH,並從另一個資料夾驗證指令。
    Skill Creator 建立配套技能,讓 Codex 日後執行任務時,知道應先執行哪些 CLI 指令,以及哪些寫入操作需要核准。

    起始提示詞

    使用 $cli-creator 建立你能使用的 CLI,並在同一個對話中使用 $skill-creator 建立配套技能。 學習來源:[docs URL, OpenAPI spec, redacted curl command, existing script path, log folder, CSV or JSON export, SQLite database path, or pasted --help output]。 CLI 首先應支援的工作:[download failed CI logs from a build URL, search support tickets and read one by ID, query an admin API, read a local database, or run one step from an existing script]。 可選的寫入工作:[create a draft comment, upload media, retry a failed job, or read-only for now]。 指令名稱:[cli-name, or recommend one]。 在編寫程式碼前,先向我展示建議的指令介面,而且只針對會阻礙建置的缺漏資訊提問。
    使用 $cli-creator 建立你能使用的 CLI,並在同一個對話中使用 $skill-creator 建立配套技能。 學習來源:[docs URL, OpenAPI spec, redacted curl command, existing script path, log folder, CSV or JSON export, SQLite database path, or pasted --help output]。 CLI 首先應支援的工作:[download failed CI logs from a build URL, search support tickets and read one by ID, query an admin API, read a local database, or run one step from an existing script]。 可選的寫入工作:[create a draft comment, upload media, retry a failed job, or read-only for now]。 指令名稱:[cli-name, or recommend one]。 在編寫程式碼前,先向我展示建議的指令介面,而且只針對會阻礙建置的缺漏資訊提問。

    簡介

    如果 Codex 反覆使用同一個 API、記錄來源、收件匣匯出資料、本機資料庫或團隊指令碼,請為這類工作提供可組合使用的介面:一項讓它能從任何資料夾執行、檢查並縮小結果範圍,還能與 gitghrg、測試及程式碼庫指令碼搭配使用的指令。

    新增配套技能,記錄 Codex 應在何時使用 CLI、要先執行哪些指令、如何讓輸出保持精簡、下載的檔案會存放在哪裡,以及哪些寫入指令需要核准。

    在這個工作流程中,$cli-creator 可協助 Codex 建置指令。$skill-creator 可協助 Codex 儲存可重複使用的技能,例如 $ci-logs,讓日後的任務可依名稱叫用這項技能。

    使用方式

    選擇 CLI 應執行的工作

    先說明你希望 Codex 完成什麼工作,而不是指定要它用什麼技術編寫。優良的 CLI 能將反覆執行的讀取、搜尋、下載、匯出、草擬、上傳、輪詢或安全寫入操作,轉換成 Codex 可從任何程式碼庫執行的指令。

    情境Codex 能透過 CLI 執行的工作
    CI 記錄需透過建置頁面存取。接受一個建置 URL,將失敗作業的記錄下載到 ./logs,並傳回檔案路徑和簡短的內容片段。
    支援服務單以每週匯出檔的形式提供。為最新的 CSV 或 JSON 匯出資料建立索引、依客戶或片語搜尋,並透過固定 ID 讀取單一支援服務單。
    API 回應太大,無法放入上下文。只列出所需欄位、依 ID 讀取完整物件,並將完整回應匯出至檔案。
    Slack 匯出資料含有很長的討論串。使用 --limit 進行搜尋、讀取單一討論串,並傳回附近的相關內容,而不是整份封存資料。
    團隊指令碼會執行四個不同步驟。將設定、探索、下載、草擬、上傳、輪詢和實際寫入分成不同的指令。
    外掛程式找得到記錄,但 Codex 需要檔案。繼續在對話中使用外掛程式;使用 CLI 下載附件、追蹤資料、報告、影片或記錄檔套件,並傳回路徑。

    提供文件、檔案或指令

    Codex 需要具體的參考資料:文件或 OpenAPI、經過遮蔽處理的 curl 指令、匯出資料或資料庫路徑、記錄資料夾,或現有指令碼。如果希望 CLI 採用熟悉的風格,請貼上一小段 --help 輸出,來源可以是 ghkubectl 或團隊自有工具。

    如果指令需要身分驗證,請告訴 Codex 應支援的環境變數名稱、設定檔路徑或登入流程。請自行在 Shell 或設定檔中設定機密值。不要將機密資訊貼到對話中。請要求 Codex 讓 CLI 的設定檢查在缺少身分驗證資訊時明確失敗。

    要求 Codex 建置 CLI 和技能

    使用本頁的起始提示詞。填入 Codex 應參考的來源,以及 CLI 首先應支援的工作。

    Codex 編寫程式碼前,應先顯示建議的指令介面,而且只針對會阻礙建置的缺漏資訊提問。

    驗證指令可從任何資料夾執行

    Codex 不應在執行 cargo runpython path/to/script.py 或尚未安裝的套件指令後便停止。請它按照日後任務的使用方式,從另一個程式碼庫或暫存資料夾測試已安裝的指令。

    以日後智慧體的方式測試 CLI

    請依照日後任務中的實際用法測試 [cli-name]。 請提供以下證明: - command -v [cli-name] 可從 CLI 原始碼資料夾外成功執行 - [cli-name] --help 會說明主要指令 - setup/auth 檢查可正常執行 - 至少有一項安全的探索、列出或搜尋指令可正常運作 - 使用探索結果中的 ID,至少有一項精確讀取指令可正常運作 - 任何大型記錄、匯出資料、追蹤資料或酬載都會寫入檔案並傳回路徑 - 除非我明確核准,否則不會執行實際寫入指令 然後讀取配套技能,告訴我下次需要這個 CLI 時該使用的最短提示詞。

    如果 Codex 傳回一大段 JSON 資料,請要求它精簡預設回應,並新增將完整酬載匯出至檔案的功能。如果它忘了哪些操作必須先經核准,請要求它先更新配套技能,再在其他任務中使用這個 CLI。

    日後使用技能

    下次需要使用 CLI 時,請叫用技能,不必再次貼上文件:

    使用 $ci-logs 下載這個建置 URL 的失敗記錄,並告訴我第一個失敗的步驟。
    使用 $support-export 搜尋本週的退款客訴,並讀取價值最高的三張支援服務單。
    使用 $admin-api 找出這位使用者的工作區、讀取帳務記錄,並草擬一則安全的帳戶備註。

    若是定期工作,請先在對話中測試一次技能,然後要求 Codex 從對話中為相同的叫用內容排程任務

    相關使用案例