使用 Craft 的 API 建構Codex CLI

Enabling the API for Documents

First, you have to enable the API in order for Craft to setup an API endpoint for your documents. Then, you use the API endpoint URL to connect to the server from Codex CLI.

步驟1

Open the “Imagine” tab

步驟2

Click “Add Your First API Connection”

步驟3

Configure your API connection with a name.

步驟4

Click “Add Document” to select which documents this API connection has access to.

步驟5

The API URL that will be used to interact with your document is now displayed at the top

步驟6

Click the “Download AI Bundle” button. This will download a folder containing the API documentation and the content of your doc.

Using the API in a Codex CLI Prompt

Once the API is enabled for your Craft docs, you can now focus on writing a prompt that Codex CLI will use to generate your project.

In order for Codex CLI to see how to use the API and understand the structure of your document, you attach the AI bundle to your prompt. This bundle is a markdown document that contains the current content of your Craft doc as well as the API documentation.

步驟1

在電腦上打開終端機。在只包含下載的「bundle.md」檔案且不包含其他任何檔案的資料夾中啟動 OpenAI Codex。

現在您可以新增提示來描述您想要建立的應用程式。以下是一個非常通用的範例，可用於測試：

Copy Prompt

請建立一個網站，將我的 Craft 文件內容視覺化。附件中包含如何存取這些資料及其結構的說明。

步驟2

按下回車鍵，等待 OpenAI Codex 實作您的應用程式。