docs: CLI docs for current commands and flags (#25399)
This commit is contained in:
OpeOginni
GitHub
parent
1ea6e6cd4b
commit
0d0ec7dc46
18 changed files with 1676 additions and 1413 deletions
|
|
@ -29,16 +29,16 @@ opencode [project]
|
|||
|
||||
#### แฟล็ก
|
||||
|
||||
| แฟล็ก | สั้น | คำอธิบาย |
|
||||
| ------------ | ---- | ---------------------------------------------------------- |
|
||||
| `--continue` | `-c` | ดำเนินการต่อจากเซสชันล่าสุด |
|
||||
| `--session` | `-s` | ID เซสชันเพื่อดำเนินการต่อ |
|
||||
| `--fork` | | แยกเซสชันเมื่อทำต่อ (ใช้กับ `--continue` หรือ `--session`) |
|
||||
| `--prompt` | | พรอมต์เริ่มต้นที่จะใช้ |
|
||||
| `--model` | `-m` | โมเดลที่จะใช้ในรูปแบบ provider/model |
|
||||
| `--agent` | | เอเจนต์ที่จะใช้ |
|
||||
| `--port` | | พอร์ตที่จะฟัง |
|
||||
| `--hostname` | | ชื่อโฮสต์ที่จะฟัง |
|
||||
| แฟล็ก | สั้น | คำอธิบาย |
|
||||
| ---------------------------------------- | ---- | ---------------------------------------------------------- |
|
||||
| <nobr><code>{"--continue"}</code></nobr> | `-c` | ดำเนินการต่อจากเซสชันล่าสุด |
|
||||
| <nobr><code>{"--session"}</code></nobr> | `-s` | ID เซสชันเพื่อดำเนินการต่อ |
|
||||
| <nobr><code>{"--fork"}</code></nobr> | | แยกเซสชันเมื่อทำต่อ (ใช้กับ `--continue` หรือ `--session`) |
|
||||
| <nobr><code>{"--prompt"}</code></nobr> | | พรอมต์เริ่มต้นที่จะใช้ |
|
||||
| <nobr><code>{"--model"}</code></nobr> | `-m` | โมเดลที่จะใช้ในรูปแบบ provider/model |
|
||||
| <nobr><code>{"--agent"}</code></nobr> | | เอเจนต์ที่จะใช้ |
|
||||
| <nobr><code>{"--port"}</code></nobr> | | พอร์ตที่จะฟัง |
|
||||
| <nobr><code>{"--hostname"}</code></nobr> | | ชื่อโฮสต์ที่จะฟัง |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -78,10 +78,14 @@ opencode attach http://10.20.30.40:4096
|
|||
|
||||
#### แฟล็ก
|
||||
|
||||
| แฟล็ก | สั้น | คำอธิบาย |
|
||||
| ----------- | ---- | -------------------------------------- |
|
||||
| `--dir` | | ไดเร็กทอรีการทำงานเพื่อเริ่มต้น TUI ใน |
|
||||
| `--session` | `-s` | ID เซสชันเพื่อดำเนินการต่อ |
|
||||
| แฟล็ก | สั้น | คำอธิบาย |
|
||||
| ---------------------------------------- | ---- | ------------------------------------------------------------------------------------------- |
|
||||
| <nobr><code>{"--dir"}</code></nobr> | | ไดเร็กทอรีการทำงานเพื่อเริ่มต้น TUI ใน |
|
||||
| <nobr><code>{"--continue"}</code></nobr> | `-c` | ดำเนินการต่อจากเซสชันล่าสุด |
|
||||
| <nobr><code>{"--session"}</code></nobr> | `-s` | ID เซสชันเพื่อดำเนินการต่อ |
|
||||
| <nobr><code>{"--fork"}</code></nobr> | | แยกเซสชันเมื่อดำเนินการต่อ (ใช้กับ `--continue` หรือ `--session`) |
|
||||
| <nobr><code>{"--password"}</code></nobr> | `-p` | รหัสผ่านการยืนยันตัวตนพื้นฐาน (ค่าเริ่มต้นคือ `OPENCODE_SERVER_PASSWORD`) |
|
||||
| <nobr><code>{"--username"}</code></nobr> | `-u` | ชื่อผู้ใช้การยืนยันตัวตนพื้นฐาน (ค่าเริ่มต้นคือ `OPENCODE_SERVER_USERNAME` หรือ `opencode`) |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -187,10 +191,10 @@ opencode github run
|
|||
|
||||
##### แฟล็ก
|
||||
|
||||
| แฟล็ก | คำอธิบาย |
|
||||
| --------- | -------------------------------------- |
|
||||
| `--event` | เหตุการณ์ GitHub เพื่อทริกเกอร์เอเจนต์ |
|
||||
| `--token` | GitHub token |
|
||||
| แฟล็ก | คำอธิบาย |
|
||||
| ------------------------------------- | -------------------------------------- |
|
||||
| <nobr><code>{"--event"}</code></nobr> | เหตุการณ์ GitHub เพื่อทริกเกอร์เอเจนต์ |
|
||||
| <nobr><code>{"--token"}</code></nobr> | GitHub token |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -296,11 +300,11 @@ opencode models anthropic
|
|||
|
||||
#### แฟล็ก
|
||||
|
||||
| แฟล็ก | คำอธิบาย |
|
||||
| ----------- | ------------------------------------------------------ |
|
||||
| `--refresh` | รีเฟรชแคชโมเดลจาก models.dev |
|
||||
| `--verbose` | แสดงรายละเอียดโมเดลเพิ่มเติม (รวมข้อมูลเมตาเช่นต้นทุน) |
|
||||
| `--json` | แสดงผลลัพธ์เป็น JSON |
|
||||
| แฟล็ก | คำอธิบาย |
|
||||
| --------------------------------------- | ------------------------------------------------------ |
|
||||
| <nobr><code>{"--refresh"}</code></nobr> | รีเฟรชแคชโมเดลจาก models.dev |
|
||||
| <nobr><code>{"--verbose"}</code></nobr> | แสดงรายละเอียดโมเดลเพิ่มเติม (รวมข้อมูลเมตาเช่นต้นทุน) |
|
||||
| <nobr><code>{"--json"}</code></nobr> | แสดงผลลัพธ์เป็น JSON |
|
||||
|
||||
ใช้แฟล็ก `--refresh` เพื่ออัปเดตรายการโมเดลที่แคชไว้ มีประโยชน์เมื่อมีการเพิ่มโมเดลใหม่ให้กับผู้ให้บริการและคุณต้องการเห็นใน OpenCode
|
||||
|
||||
|
|
@ -336,20 +340,25 @@ opencode run --attach http://localhost:4096 "Explain async/await in JavaScript"
|
|||
|
||||
#### แฟล็ก
|
||||
|
||||
| แฟล็ก | สั้น | คำอธิบาย |
|
||||
| ------------ | ---- | ---------------------------------------------------------------------- |
|
||||
| `--command` | | คำสั่งที่จะรัน (ใช้ส่วนที่เหลือของ args เป็นอาร์กิวเมนต์) |
|
||||
| `--continue` | `-c` | ดำเนินการต่อจากเซสชันล่าสุด |
|
||||
| `--session` | `-s` | ID เซสชันเพื่อดำเนินการต่อ |
|
||||
| `--fork` | | แยกเซสชันเมื่อทำต่อ (ใช้กับ `--continue` หรือ `--session`) |
|
||||
| `--share` | | สร้างลิงก์แชร์สำหรับเซสชัน |
|
||||
| `--model` | `-m` | โมเดลที่จะใช้ในรูปแบบ provider/model |
|
||||
| `--agent` | | เอเจนต์ที่จะใช้ |
|
||||
| `--file` | `-f` | แนบไฟล์ไปกับข้อความ |
|
||||
| `--format` | | รูปแบบเอาต์พุต: text (จัดรูปแบบ) หรือ json (JSON ดิบ) |
|
||||
| `--title` | | ชื่อสำหรับเซสชัน (หากไม่ได้ระบุ จะสร้างจากพรอมต์) |
|
||||
| `--attach` | | แนบไปกับเซิร์ฟเวอร์ opencode ที่ทำงานอยู่ (เช่น http://localhost:4096) |
|
||||
| `--port` | | พอร์ตสำหรับเซิร์ฟเวอร์ภายในเครื่อง (หากไม่ได้ระบุ จะใช้พอร์ตสุ่ม) |
|
||||
| แฟล็ก | สั้น | คำอธิบาย |
|
||||
| ---------------------------------------- | ---- | ------------------------------------------------------------------------------------------- |
|
||||
| <nobr><code>{"--command"}</code></nobr> | | คำสั่งที่จะรัน (ใช้ส่วนที่เหลือของ args เป็นอาร์กิวเมนต์) |
|
||||
| <nobr><code>{"--continue"}</code></nobr> | `-c` | ดำเนินการต่อจากเซสชันล่าสุด |
|
||||
| <nobr><code>{"--session"}</code></nobr> | `-s` | ID เซสชันเพื่อดำเนินการต่อ |
|
||||
| <nobr><code>{"--fork"}</code></nobr> | | แยกเซสชันเมื่อทำต่อ (ใช้กับ `--continue` หรือ `--session`) |
|
||||
| <nobr><code>{"--share"}</code></nobr> | | สร้างลิงก์แชร์สำหรับเซสชัน |
|
||||
| <nobr><code>{"--model"}</code></nobr> | `-m` | โมเดลที่จะใช้ในรูปแบบ provider/model |
|
||||
| <nobr><code>{"--agent"}</code></nobr> | | เอเจนต์ที่จะใช้ |
|
||||
| <nobr><code>{"--file"}</code></nobr> | `-f` | แนบไฟล์ไปกับข้อความ |
|
||||
| <nobr><code>{"--format"}</code></nobr> | | รูปแบบเอาต์พุต: text (จัดรูปแบบ) หรือ json (JSON ดิบ) |
|
||||
| <nobr><code>{"--title"}</code></nobr> | | ชื่อสำหรับเซสชัน (หากไม่ได้ระบุ จะสร้างจากพรอมต์) |
|
||||
| <nobr><code>{"--attach"}</code></nobr> | | แนบไปกับเซิร์ฟเวอร์ opencode ที่ทำงานอยู่ (เช่น http://localhost:4096) |
|
||||
| <nobr><code>{"--password"}</code></nobr> | `-p` | รหัสผ่านการยืนยันตัวตนพื้นฐาน (ค่าเริ่มต้นคือ `OPENCODE_SERVER_PASSWORD`) |
|
||||
| <nobr><code>{"--username"}</code></nobr> | `-u` | ชื่อผู้ใช้การยืนยันตัวตนพื้นฐาน (ค่าเริ่มต้นคือ `OPENCODE_SERVER_USERNAME` หรือ `opencode`) |
|
||||
| <nobr><code>{"--dir"}</code></nobr> | | ไดเร็กทอรีสำหรับรัน หรือเส้นทางบนเซิร์ฟเวอร์ระยะไกลเมื่อแนบ |
|
||||
| <nobr><code>{"--variant"}</code></nobr> | | ตัวแปรโมเดล (ระดับการใช้เหตุผลเฉพาะผู้ให้บริการ) |
|
||||
| <nobr><code>{"--thinking"}</code></nobr> | | แสดงบล็อกความคิด |
|
||||
| <nobr><code>{"--port"}</code></nobr> | | พอร์ตสำหรับเซิร์ฟเวอร์ภายในเครื่อง (หากไม่ได้ระบุ จะใช้พอร์ตสุ่ม) |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -365,12 +374,12 @@ opencode serve
|
|||
|
||||
#### แฟล็ก
|
||||
|
||||
| แฟล็ก | คำอธิบาย |
|
||||
| ------------ | -------------------------------------- |
|
||||
| `--port` | พอร์ตที่จะฟัง |
|
||||
| `--hostname` | ชื่อโฮสต์ที่จะฟัง |
|
||||
| `--mdns` | เปิดใช้งานการค้นหา mDNS |
|
||||
| `--cors` | ต้นกำเนิดเพิ่มเติมที่อนุญาตสำหรับ CORS |
|
||||
| แฟล็ก | คำอธิบาย |
|
||||
| ---------------------------------------- | -------------------------------------- |
|
||||
| <nobr><code>{"--port"}</code></nobr> | พอร์ตที่จะฟัง |
|
||||
| <nobr><code>{"--hostname"}</code></nobr> | ชื่อโฮสต์ที่จะฟัง |
|
||||
| <nobr><code>{"--mdns"}</code></nobr> | เปิดใช้งานการค้นหา mDNS |
|
||||
| <nobr><code>{"--cors"}</code></nobr> | ต้นกำเนิดเพิ่มเติมที่อนุญาตสำหรับ CORS |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -394,10 +403,10 @@ opencode session list
|
|||
|
||||
##### แฟล็ก
|
||||
|
||||
| แฟล็ก | สั้น | คำอธิบาย |
|
||||
| ------------- | ---- | ----------------------------- |
|
||||
| `--max-count` | `-n` | จำกัดการแสดงผล N รายการล่าสุด |
|
||||
| `--format` | | รูปแบบ table หรือ json |
|
||||
| แฟล็ก | สั้น | คำอธิบาย |
|
||||
| ----------------------------------------- | ---- | ----------------------------- |
|
||||
| <nobr><code>{"--max-count"}</code></nobr> | `-n` | จำกัดการแสดงผล N รายการล่าสุด |
|
||||
| <nobr><code>{"--format"}</code></nobr> | | รูปแบบ table หรือ json |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -411,12 +420,12 @@ opencode stats
|
|||
|
||||
#### แฟล็ก
|
||||
|
||||
| แฟล็ก | คำอธิบาย |
|
||||
| ----------- | ---------------------------------------------------- |
|
||||
| `--days` | แสดงสถิติของ N วันที่ผ่านมา (ค่าเริ่มต้น: ตลอดเวลา) |
|
||||
| `--tools` | แสดงสถิติการใช้เครื่องมือ |
|
||||
| `--models` | แสดงรายละเอียดการใช้งานโมเดล (ซ่อนไว้ตามค่าเริ่มต้น) |
|
||||
| `--project` | กรองตามโครงการ (ค่าเริ่มต้น: โครงการปัจจุบัน) |
|
||||
| แฟล็ก | คำอธิบาย |
|
||||
| --------------------------------------- | ---------------------------------------------------- |
|
||||
| <nobr><code>{"--days"}</code></nobr> | แสดงสถิติของ N วันที่ผ่านมา (ค่าเริ่มต้น: ตลอดเวลา) |
|
||||
| <nobr><code>{"--tools"}</code></nobr> | แสดงสถิติการใช้เครื่องมือ |
|
||||
| <nobr><code>{"--models"}</code></nobr> | แสดงรายละเอียดการใช้งานโมเดล (ซ่อนไว้ตามค่าเริ่มต้น) |
|
||||
| <nobr><code>{"--project"}</code></nobr> | กรองตามโครงการ (ค่าเริ่มต้น: โครงการปัจจุบัน) |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -461,12 +470,12 @@ opencode web
|
|||
|
||||
#### แฟล็ก
|
||||
|
||||
| แฟล็ก | คำอธิบาย |
|
||||
| ------------ | -------------------------------------- |
|
||||
| `--port` | พอร์ตที่จะฟัง |
|
||||
| `--hostname` | ชื่อโฮสต์ที่จะฟัง |
|
||||
| `--mdns` | เปิดใช้งานการค้นหา mDNS |
|
||||
| `--cors` | ต้นกำเนิดเพิ่มเติมที่อนุญาตสำหรับ CORS |
|
||||
| แฟล็ก | คำอธิบาย |
|
||||
| ---------------------------------------- | -------------------------------------- |
|
||||
| <nobr><code>{"--port"}</code></nobr> | พอร์ตที่จะฟัง |
|
||||
| <nobr><code>{"--hostname"}</code></nobr> | ชื่อโฮสต์ที่จะฟัง |
|
||||
| <nobr><code>{"--mdns"}</code></nobr> | เปิดใช้งานการค้นหา mDNS |
|
||||
| <nobr><code>{"--cors"}</code></nobr> | ต้นกำเนิดเพิ่มเติมที่อนุญาตสำหรับ CORS |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -482,11 +491,11 @@ opencode acp
|
|||
|
||||
#### แฟล็ก
|
||||
|
||||
| แฟล็ก | คำอธิบาย |
|
||||
| ------------ | ------------------ |
|
||||
| `--cwd` | ไดเร็กทอรีการทำงาน |
|
||||
| `--port` | พอร์ตที่จะฟัง |
|
||||
| `--hostname` | ชื่อโฮสต์ที่จะฟัง |
|
||||
| แฟล็ก | คำอธิบาย |
|
||||
| ---------------------------------------- | ------------------ |
|
||||
| <nobr><code>{"--cwd"}</code></nobr> | ไดเร็กทอรีการทำงาน |
|
||||
| <nobr><code>{"--port"}</code></nobr> | พอร์ตที่จะฟัง |
|
||||
| <nobr><code>{"--hostname"}</code></nobr> | ชื่อโฮสต์ที่จะฟัง |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -500,12 +509,12 @@ opencode uninstall
|
|||
|
||||
#### แฟล็ก
|
||||
|
||||
| แฟล็ก | สั้น | คำอธิบาย |
|
||||
| --------------- | ---- | ----------------------------------- |
|
||||
| `--keep-config` | `-c` | เก็บไฟล์การกำหนดค่าไว้ |
|
||||
| `--keep-data` | `-d` | เก็บไฟล์ข้อมูล (เซสชันและสแน็ปช็อต) |
|
||||
| `--dry-run` | | แสดงสิ่งที่จะลบออกโดยไม่ต้องทำจริง |
|
||||
| `--force` | `-f` | บังคับลบโดยไม่มีการแจ้งเตือน |
|
||||
| แฟล็ก | สั้น | คำอธิบาย |
|
||||
| ------------------------------------------- | ---- | ----------------------------------- |
|
||||
| <nobr><code>{"--keep-config"}</code></nobr> | `-c` | เก็บไฟล์การกำหนดค่าไว้ |
|
||||
| <nobr><code>{"--keep-data"}</code></nobr> | `-d` | เก็บไฟล์ข้อมูล (เซสชันและสแน็ปช็อต) |
|
||||
| <nobr><code>{"--dry-run"}</code></nobr> | | แสดงสิ่งที่จะลบออกโดยไม่ต้องทำจริง |
|
||||
| <nobr><code>{"--force"}</code></nobr> | `-f` | บังคับลบโดยไม่มีการแจ้งเตือน |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -531,9 +540,9 @@ opencode upgrade v0.1.48
|
|||
|
||||
#### แฟล็ก
|
||||
|
||||
| แฟล็ก | สั้น | คำอธิบาย |
|
||||
| ---------- | ---- | ----------------------------------------------- |
|
||||
| `--method` | `-m` | วิธีการติดตั้งที่ใช้ curl, npm, pnpm, bun, brew |
|
||||
| แฟล็ก | สั้น | คำอธิบาย |
|
||||
| -------------------------------------- | ---- | ----------------------------------------------- |
|
||||
| <nobr><code>{"--method"}</code></nobr> | `-m` | วิธีการติดตั้งที่ใช้ curl, npm, pnpm, bun, brew |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -541,12 +550,12 @@ opencode upgrade v0.1.48
|
|||
|
||||
OpenCode CLI ยอมรับแฟล็กสากลต่อไปนี้สำหรับทุกคำสั่ง
|
||||
|
||||
| แฟล็ก | สั้น | คำอธิบาย |
|
||||
| -------------- | ---- | ----------------------------------------- |
|
||||
| `--help` | `-h` | แสดงความช่วยเหลือ |
|
||||
| `--version` | `-v` | พิมพ์เวอร์ชัน |
|
||||
| `--print-logs` | | พิมพ์บันทึกไปยัง stderr |
|
||||
| `--log-level` | | ระดับการบันทึก (DEBUG, INFO, WARN, ERROR) |
|
||||
| แฟล็ก | สั้น | คำอธิบาย |
|
||||
| ------------------------------------------ | ---- | ----------------------------------------- |
|
||||
| <nobr><code>{"--help"}</code></nobr> | `-h` | แสดงความช่วยเหลือ |
|
||||
| <nobr><code>{"--version"}</code></nobr> | `-v` | พิมพ์เวอร์ชัน |
|
||||
| <nobr><code>{"--print-logs"}</code></nobr> | | พิมพ์บันทึกไปยัง stderr |
|
||||
| <nobr><code>{"--log-level"}</code></nobr> | | ระดับการบันทึก (DEBUG, INFO, WARN, ERROR) |
|
||||
|
||||
---
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue