EthanWin
  • NEW!
    NEW!  Connect Ideas Across Notes
    Save time and share insights. With Paragraph Citation, you can quote others’ work with source info built in. If someone cites your note, you’ll see a card showing where it’s used—bringing notes closer together.
    Got it
      • Create new note
      • Create a note from template
        • Sharing URL Link copied
        • /edit
        • View mode
          • Edit mode
          • View mode
          • Book mode
          • Slide mode
          Edit mode View mode Book mode Slide mode
        • Customize slides
        • Note Permission
        • Read
          • Only me
          • Signed-in users
          • Everyone
          Only me Signed-in users Everyone
        • Write
          • Only me
          • Signed-in users
          • Everyone
          Only me Signed-in users Everyone
        • Engagement control Commenting, Suggest edit, Emoji Reply
      • Invite by email
        Invitee

        This note has no invitees

      • Publish Note

        Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note No publishing access yet

        Your note will be visible on your profile and discoverable by anyone.
        Your note is now live.
        This note is visible on your profile and discoverable online.
        Everyone on the web can find and read all notes of this public team.

        Your account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

        Your team account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

        Explore these features while you wait
        Complete general settings
        Bookmark and like published notes
        Write a few more notes
        Complete general settings
        Write a few more notes
        See published notes
        Unpublish note
        Please check the box to agree to the Community Guidelines.
        View profile
      • Commenting
        Permission
        Disabled Forbidden Owners Signed-in users Everyone
      • Enable
      • Permission
        • Forbidden
        • Owners
        • Signed-in users
        • Everyone
      • Suggest edit
        Permission
        Disabled Forbidden Owners Signed-in users Everyone
      • Enable
      • Permission
        • Forbidden
        • Owners
        • Signed-in users
      • Emoji Reply
      • Enable
      • Versions and GitHub Sync
      • Note settings
      • Note Insights New
      • Engagement control
      • Make a copy
      • Transfer ownership
      • Delete this note
      • Save as template
      • Insert from template
      • Import from
        • Dropbox
        • Google Drive
        • Gist
        • Clipboard
      • Export to
        • Dropbox
        • Google Drive
        • Gist
      • Download
        • Markdown
        • HTML
        • Raw HTML
    Menu Note settings Note Insights Versions and GitHub Sync Sharing URL Create Help
    Create Create new note Create a note from template
    Menu
    Options
    Engagement control Make a copy Transfer ownership Delete this note
    Import from
    Dropbox Google Drive Gist Clipboard
    Export to
    Dropbox Google Drive Gist
    Download
    Markdown HTML Raw HTML
    Back
    Sharing URL Link copied
    /edit
    View mode
    • Edit mode
    • View mode
    • Book mode
    • Slide mode
    Edit mode View mode Book mode Slide mode
    Customize slides
    Note Permission
    Read
    Only me
    • Only me
    • Signed-in users
    • Everyone
    Only me Signed-in users Everyone
    Write
    Only me
    • Only me
    • Signed-in users
    • Everyone
    Only me Signed-in users Everyone
    Engagement control Commenting, Suggest edit, Emoji Reply
  • Invite by email
    Invitee

    This note has no invitees

  • Publish Note

    Share your work with the world Congratulations! 🎉 Your note is out in the world Publish Note No publishing access yet

    Your note will be visible on your profile and discoverable by anyone.
    Your note is now live.
    This note is visible on your profile and discoverable online.
    Everyone on the web can find and read all notes of this public team.

    Your account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

    Your team account was recently created. Publishing will be available soon, allowing you to share notes on your public page and in search results.

    Explore these features while you wait
    Complete general settings
    Bookmark and like published notes
    Write a few more notes
    Complete general settings
    Write a few more notes
    See published notes
    Unpublish note
    Please check the box to agree to the Community Guidelines.
    View profile
    Engagement control
    Commenting
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    • Everyone
    Suggest edit
    Permission
    Disabled Forbidden Owners Signed-in users Everyone
    Enable
    Permission
    • Forbidden
    • Owners
    • Signed-in users
    Emoji Reply
    Enable
    Import from Dropbox Google Drive Gist Clipboard
       Owned this note    Owned this note      
    Published Linked with GitHub
    • Any changes
      Be notified of any changes
    • Mention me
      Be notified of mention me
    • Unsubscribe
    以下將示範如何利用 Open Codex CLI 打造一個專屬的程式開發代理人(agent),讓你能透過命令列快速進行程式碼檢視、重構、測試或自動化工作。範例以 Node.js 環境為主,並採用 YAML/JSON 來設定代理人角色及工具整合。 --- ## 一、前置需求 1. 已安裝 Node.js (v14+)與 npm/yarn 2. 已申請 OpenAI API 金鑰(`OPENAI_API_KEY`) 3. 已安裝 Git(如需版本控制) --- ## 二、安裝 Open Codex CLI ```bash # 使用 npm 安裝 CLI npm install -g @openai/codex-cli # 確認版本 codex --version ``` --- ## 三、設定 API 金鑰 將 金鑰設定在環境變數中,或放到使用者主目錄下的設定檔: ```bash # Unix/macOS export OPENAI_API_KEY="你的_api_金鑰" # Windows PowerShell setx OPENAI_API_KEY "你的_api_金鑰" ``` 或在 `~/.config/codex/config.yaml` 中: ```yaml openai: api_key: "你的_api_金鑰" model: "gpt-4-codex" # 或 gpt-3.5-codex ``` --- ## 四、建立專案骨架 在工作目錄下初始化一個 Codex 專案: ```bash mkdir my-dev-agent cd my-dev-agent codex init ``` 這會產生: ```perl my-dev-agent/ ├── codex.yaml # 代理人設定檔 └── src/ # 可放測試程式或範例檔 ``` --- ## 五、設定代理人角色(codex.yaml) 在 `codex.yaml` 中定義你的「代理人性格」、專長工具和記憶設定。例如: ```yaml agent: name: DevAssistant description: | 你是一位專業的程式開發助理,精通 JavaScript、TypeScript、Node.js, 熟悉測試(Jest)、CI/CD(GitHub Actions)與程式碼重構。 system_prompt: | 你將協助使用者撰寫、檢閱和重構程式碼,並給出最佳實踐建議。 temperature: 0.2 max_tokens: 1024 tools: - name: shell description: 執行 shell 指令與顯示結果 - name: git description: 執行 git 指令並解析回傳 - name: fs description: 讀寫檔案系統 memory: enabled: true type: local path: ./agent_memory.json ``` - **`agent.system_prompt`**:控制代理人整體語氣與專長領域 - **`tools`**:列出可用的工具,例如執行 shell、Git 操作或存取檔案 - **`memory`**:是否保留上下文(如問題、專案結構),以便多輪對話 --- ## 六、常用 CLI 命令 | 命令 | 功能 | | --- | --- | | `codex chat` | 進入互動式對話模式 | | `codex run [cmd]` | 直接向代理人下達指令(如 `codex run "fix lint"`) | | `codex dev` | 偵測專案變動後自動觸發預設任務 | | `codex test` | 執行代理人針對程式碼提出的測試用例 | 範例:要求重構一段程式碼 ```bash codex run "請幫我重構 src/utils.js 中的函式 calculateSum,使其更具可讀性並加上單元測試" ``` --- ## 七、範例:自動化格式化與測試 可在 `codex.yaml` 加入一組預設任務(workflows): ```yaml workflows: precommit: - shell: "npm run lint -- --fix" - shell: "npm test" ci: - git: "checkout $BRANCH" - shell: "npm ci" - shell: "npm run build" - shell: "npm test" ``` 接著執行: ```bash codex run "執行 precommit 工作流程" ``` Cli 會依序跑完 `lint --fix`、`npm test`,並將結果回報給你。 --- ## 八、整合 VS Code 1. 安裝 “OpenAI Codex CLI” 擴充套件 2. 在工作區設定檔 `.vscode/settings.json`: ```json { "codex.cliPath": "codex", "codex.agentConfig": "${workspaceFolder}/codex.yaml" } ``` 3. 即可在編輯器側邊呼叫代理人:選取程式碼 → 右鍵 → “Codex: Ask Agent” --- ## 九、進階技巧 - **自定記憶觸發**:撰寫自定義 Hook,在特定檔案或目錄變動時自動將變更記錄到 `memory`。 - **複合工具**:自建工具插件(例如串接 Jira、Slack),在 `tools` 中註冊後,可讓代理人同時執行程式開發與專案管理。 - **多代理人協作**:可定義多個 YAML 配置檔,分別為「測試代理人」、「文件撰寫代理人」等,並串聯工作流程。 --- 透過上述流程,你就能快速打造一個專屬於自己、且高度可客製化的程式開發代理人,無論是程式重構、測試驅動開發,或是整合 CI/CD,都能一鍵完成!若有更進階的需求或整合問題,歡迎再討論。

    Import from clipboard

    Paste your markdown or webpage here...

    Advanced permission required

    Your current role can only read. Ask the system administrator to acquire write and comment permission.

    This team is disabled

    Sorry, this team is disabled. You can't edit this note.

    This note is locked

    Sorry, only owner can edit this note.

    Reach the limit

    Sorry, you've reached the max length this note can be.
    Please reduce the content or divide it to more notes, thank you!

    Import from Gist

    Import from Snippet

    or

    Export to Snippet

    Are you sure?

    Do you really want to delete this note?
    All users will lose their connection.

    Create a note from template

    Create a note from template

    Oops...
    This template has been removed or transferred.
    Upgrade
    All
    • All
    • Team
    No template.

    Create a template

    Upgrade

    Delete template

    Do you really want to delete this template?
    Turn this template into a regular note and keep its content, versions, and comments.

    This page need refresh

    You have an incompatible client version.
    Refresh to update.
    New version available!
    See releases notes here
    Refresh to enjoy new features.
    Your user state has changed.
    Refresh to load new user state.

    Sign in

    Forgot password
    or
    Sign in via Google Sign in via Facebook Sign in via X(Twitter) Sign in via GitHub Sign in via Dropbox Sign in with Wallet
    Wallet ( )
    Connect another wallet

    New to HackMD? Sign up

    By signing in, you agree to our terms of service.

    Help

    • English
    • 中文
    • Français
    • Deutsch
    • 日本語
    • Español
    • Català
    • Ελληνικά
    • Português
    • italiano
    • Türkçe
    • Русский
    • Nederlands
    • hrvatski jezik
    • język polski
    • Українська
    • हिन्दी
    • svenska
    • Esperanto
    • dansk

    Documents

    Help & Tutorial

    How to use Book mode

    Slide Example

    API Docs

    Edit in VSCode

    Install browser extension

    Contacts

    Feedback

    Discord

    Send us email

    Resources

    Releases

    Pricing

    Blog

    Policy

    Terms

    Privacy

    Cheatsheet

    Syntax Example Reference
    # Header Header 基本排版
    - Unordered List
    • Unordered List
    1. Ordered List
    1. Ordered List
    - [ ] Todo List
    • Todo List
    > Blockquote
    Blockquote
    **Bold font** Bold font
    *Italics font* Italics font
    ~~Strikethrough~~ Strikethrough
    19^th^ 19th
    H~2~O H2O
    ++Inserted text++ Inserted text
    ==Marked text== Marked text
    [link text](https:// "title") Link
    ![image alt](https:// "title") Image
    `Code` Code 在筆記中貼入程式碼
    ```javascript
    var i = 0;
    ```
    var i = 0;
    :smile: :smile: Emoji list
    {%youtube youtube_id %} Externals
    $L^aT_eX$ LaTeX
    :::info
    This is a alert area.
    :::

    This is a alert area.

    Versions and GitHub Sync
    Get Full History Access

    • Edit version name
    • Delete

    revision author avatar     named on  

    More Less

    Note content is identical to the latest version.
    Compare
      Choose a version
      No search result
      Version not found
    Sign in to link this note to GitHub
    Learn more
    This note is not linked with GitHub
     

    Feedback

    Submission failed, please try again

    Thanks for your support.

    On a scale of 0-10, how likely is it that you would recommend HackMD to your friends, family or business associates?

    Please give us some advice and help us improve HackMD.

     

    Thanks for your feedback

    Remove version name

    Do you want to remove this version name and description?

    Transfer ownership

    Transfer to
      Warning: is a public team. If you transfer note to this team, everyone on the web can find and read this note.

        Link with GitHub

        Please authorize HackMD on GitHub
        • Please sign in to GitHub and install the HackMD app on your GitHub repo.
        • HackMD links with GitHub through a GitHub App. You can choose which repo to install our App.
        Learn more  Sign in to GitHub

        Push the note to GitHub Push to GitHub Pull a file from GitHub

          Authorize again
         

        Choose which file to push to

        Select repo
        Refresh Authorize more repos
        Select branch
        Select file
        Select branch
        Choose version(s) to push
        • Save a new version and push
        • Choose from existing versions
        Include title and tags
        Available push count

        Pull from GitHub

         
        File from GitHub
        File from HackMD

        GitHub Link Settings

        File linked

        Linked by
        File path
        Last synced branch
        Available push count

        Danger Zone

        Unlink
        You will no longer receive notification when GitHub file changes after unlink.

        Syncing

        Push failed

        Push successfully