ข้ามไปยังเนื้อหา

คู่มืออ้างอิง CLI

หน้านี้แสดงรายการคำสั่งของ codeknit ทุกคำสั่ง อาร์กิวเมนต์ และแฟล็กทั้งหมด สำหรับคำแนะนำที่เน้นงาน โปรดดูที่ คู่มือคำสั่ง parse, คู่มือคำสั่ง graph และ คู่มือคำสั่ง fingerprint

คำสั่ง วัตถุประสงค์
codeknit เปิดใช้งาน UI อินเตอร์เฟซแบบ terminal แบบโต้ตอบ
codeknit parse <input-path> [output-dir] ดึงสัญลักษณ์และความสัมพันธ์ลงในเอาต์พุต .skt หรือ JSON
codeknit graph show <input-path> สร้างกราฟ HTML แบบโต้ตอบ
codeknit graph analyze <input-path> รันอัลกอริทึมกราฟโครงสร้างและเขียนรายงาน .skt
codeknit graph hotspots <input-path> จัดอันดับ hotspots การเปลี่ยนแปลงโดยใช้ประวัติ Git และโครงสร้างกราฟ
codeknit fingerprint <input-path> ตรวจจับโค้ดที่ซ้ำและเกือบซ้ำ
codeknit completion <shell> สร้างสคริปต์เติมคำสั่งสำหรับ shell

คำสั่งที่ประมวลผลซอร์สโค้ดมีทั้งหมด 5 คำสั่ง ได้แก่ parse, graph show, graph analyze, graph hotspots และ fingerprint คำสั่งเหล่านี้ใช้แฟล็กที่อธิบายไว้ใน แฟล็กการประมวลผลซอร์สโค้ดที่ใช้ร่วมกัน

แฟล็ก ประเภท ค่าเริ่มต้น คำอธิบาย
--version bool false แสดงข้อมูลเวอร์ชัน
-h, --help bool false แสดงความช่วยเหลือสำหรับคำสั่ง

แฟล็กเหล่านี้ปรากฏในตารางของแต่ละคำสั่งที่ประมวลผลซอร์สโค้ด

แฟล็ก ประเภท ค่าเริ่มต้น ค่าที่อนุญาต คำอธิบาย
--header-language string c c, cpp Parser ที่ใช้สำหรับไฟล์ .h
--include GLOB string, repeatable ทุกซอร์สที่รองรับ Gitignore-style glob รวมเส้นทางซอร์สที่ตรงกัน หลายรูปแบบจะรวมกันเป็น union
--exclude GLOB string, repeatable ไม่มี Gitignore-style glob ไม่รวมเส้นทางหรือไดเรกทอรีที่ตรงกัน
--max-file-size BYTES int 10485760 (10 MiB) 0 หรือมากกว่า ข้ามไฟล์ซอร์สที่มีขนาดใหญ่กว่านี้ 0 จะปิดการจำกัดขนาด
--strict bool false — ล้มเหลวก่อนที่จะเขียนเอาต์พุตหากเกิดการสแกนหรือวินิจฉัยการแยกวิเคราะห์

ใช้กับไฟล์ .h เท่านั้น ส่วนขยายอื่นๆ จะใช้ parser ปกติ (.hpp และ .hxx ใช้ C++ อยู่แล้ว)

  • c (ค่าเริ่มต้น) รักษาการแยกวิเคราะห์ macro, typedef และ union ของ C
  • cpp เลือก parser ของ C++ ใช้สำหรับโปรเจ็กต์ C++ ที่มีไฟล์ส่วนหัวชื่อ .h

TUI ใช้การเลือก c เป็นค่าเริ่มต้นสำหรับไฟล์ .h

Terminal window
codeknit parse ./src --header-language cpp

สำหรับความสามารถในการแยกวิเคราะห์ที่ผ่านการทดสอบและข้อจำกัดที่ทราบต่อภาษา โปรดดูที่ การรองรับภาษาและความเที่ยงตรงของ API หน้านั้นอธิบายโครงสร้างที่ผ่านการทดสอบ ไม่ใช่การครอบคลุมภาษาหรือความหมายของคอมไพเลอร์ทั้งหมด

  • รูปแบบใช้ glob แบบ gitignore ที่คั่นด้วยเครื่องหมายทับ เทียบกับไดเรกทอรีอินพุต สำหรับอินพุตไฟล์เดียว รูปแบบจะตรงกับชื่อฐานของไฟล์
  • ใส่เครื่องหมายคำพูดครอบรูปแบบเพื่อไม่ให้ shell ขยายรูปแบบ
  • การยกเว้นมีความสำคัญมากกว่าการรวม
  • การรวมไม่ได้ลบล้างกฎ .gitignore การกรองไฟล์ทดสอบ หรือการยกเว้นในตัว
  • รูปแบบปฏิเสธ (!pattern) ไม่ได้รับการยอมรับใน --include หรือ --exclude
  • การสแกนไดเรกทอรีให้ความสำคัญกับไฟล์ .gitignore ที่อยู่ในระดับบนและระดับล่างโดยไม่ขึ้นกับไดเรกทอรีการทำงานปัจจุบัน
  • การเลือกไฟล์ซอร์สปกติอย่างชัดเจนจะข้ามการกรอง ignore และ test การรวม การยกเว้น และขีดจำกัดขนาดยังคงมีผล
  • ไฟล์ทดสอบจะถูกยกเว้นเว้นแต่จะตั้ง --collect-test
Terminal window
codeknit parse ./src --include '**/*.go' --exclude '**/generated/' --strict
  • Symlink, symlink ของไดเรกทอรี และไฟล์ที่ไม่ใช่ไฟล์ปกติจะถูกข้ามและรายงาน
  • เส้นทางที่ไม่สามารถอ่านได้ การอ่านไฟล์ ignore ล้มเหลว ซอร์สที่มีขนาดใหญ่เกินไป และคำเตือนด้านไวยากรณ์ทำให้การวิเคราะห์ไม่สมบูรณ์
  • โดยค่าเริ่มต้น ผลลัพธ์บางส่วนที่ใช้งานได้จะถูกเก็บไว้ การวินิจฉัยจะปรากฏบน stderr parse ยังบันทึกไว้ใน JSON errors หรือใน SKT [errors]
  • เมื่อใช้ --strict การวิเคราะห์ที่ไม่สมบูรณ์จะถูกปฏิเสธก่อนที่จะเขียนเอาต์พุต
  • การรันที่ไม่มีซอร์สที่รองรับที่ถูกเลือก หรือการที่ทุกการอ่านซอร์สล้มเหลว จะออกจากระบบโดยไม่สำเร็จเสมอ
  • TUI ใช้นโยบาย symlink เดียวกันและค่าเริ่มต้น 10 MiB ฟอร์มของ TUI ไม่เปิดเผยแฟล็กการเลือกและ strict

ดู ความน่าเชื่อถือของการวิเคราะห์ สำหรับการรับประกันที่แน่นอน

Terminal window
codeknit

การรัน codeknit โดยไม่มีคำสั่งย่อยจะเปิดใช้งาน UI อินเตอร์เฟซแบบ terminal แบบโต้ตอบ UI นี้มีคำสั่ง parse, graph show, graph analyze, graph hotspots และ fingerprint พร้อมกับตัวเลือกของคำสั่งเหล่านั้น

Terminal window
codeknit parse <input-path> [output-dir]
อาร์กิวเมนต์ จำเป็น ค่าเริ่มต้น คำอธิบาย
input-path ใช่ — ไดเรกทอรีซอร์สหรือไฟล์ซอร์สเดียว
output-dir ไม่ ./skeleton ไดเรกทอรีเอาต์พุต ไม่ได้ใช้เมื่อ --output-mode เป็น inline
แฟล็ก ประเภท ค่าเริ่มต้น ค่าที่อนุญาต คำอธิบาย
--output-mode string directory-flat inline, directory-flat, directory-tree ตำแหน่งและวิธีการเขียนเอาต์พุต
--format string skt skt, json รูปแบบเอาต์พุต
--max-lines int 500 สำหรับ directory-tree ต้องมีค่าตั้งแต่ 3 ขึ้นไป จำนวนบรรทัดเป้าหมายสำหรับเอาต์พุตแบบ flat ขีดจำกัดชิ้นส่วนซอร์สแบบ hard สำหรับเอาต์พุตแบบ tree
--collect-test bool false — รวมไฟล์ทดสอบ
--minify bool false — เปิดใช้งานการบีบอัดเอาต์พุตแบบใช้พจนานุกรม
--edges bool false — รวมส่วน [edges] ปิดโดยค่าเริ่มต้นเพื่อประหยัดโทเค็น
--clean bool false — แทนที่เอาต์พุตที่สร้างขึ้นก่อนหน้า เฉพาะหลังจากการสร้างสำเร็จเท่านั้น
--workers int 0 (NumCPU) 0 หรือมากกว่า จำนวนสูงสุดของ goroutines การแยกวิเคราะห์พร้อมกัน
--verbose bool false — แสดงข้อมูลความคืบหน้า
--header-language string c c, cpp Parser ที่ใช้สำหรับไฟล์ .h
--include GLOB string, repeatable ทุกซอร์สที่รองรับ — รวมเส้นทางซอร์สที่ตรงกัน
--exclude GLOB string, repeatable ไม่มี — ไม่รวมเส้นทางหรือไดเรกทอรีที่ตรงกัน
--max-file-size BYTES int 10485760 0 ปิดการจำกัดขนาด ข้ามไฟล์ซอร์สที่มีขนาดใหญ่กว่า
--strict bool false — ล้มเหลวก่อนเขียนเอาต์พุตหากเกิดการสแกนหรือวินิจฉัยการแยกวิเคราะห์
ค่า พฤติกรรม
inline เขียนไปยัง stdout ไม่ได้ใช้ไดเรกทอรีเอาต์พุต
directory-flat เขียนไฟล์ที่แบ่งเป็นชิ้นไปยังไดเรกทอรีเอาต์พุต บล็อกซอร์สจะคงสภาพเดิม ดังนั้น --max-lines จึงเป็นเป้าหมายการแบ่งแทนที่จะเป็นขีดจำกัดแบบ hard
directory-tree สร้างสำเนาต้นไม้ซอร์ส ชื่อจะคงสกุลของซอร์ส (foo.c.skt, foo.h.skt) ไฟล์ที่แบ่งจะใช้ foo.c_part1.skt
  • หากไม่มี --clean เอาต์พุตที่สร้างขึ้นก่อนหน้าสำหรับรูปแบบที่เลือกในไดเรกทอรีเอาต์พุตจะทำให้เกิดข้อผิดพลาด
  • เมื่อใช้ --clean ไฟล์ .skt ที่ล้าสมัย (รูปแบบ SKT) หรือ codeknit.json (รูปแบบ JSON) จะถูกแทนที่หลังจากการสร้างสำเร็จเท่านั้น รายการที่ไม่เกี่ยวข้องจะถูกเก็บรักษาไว้
  • ในรูปแบบ JSON โหมดไดเรกทอรีจะเขียน codeknit.json JSON เป็นเอกสารเดียวและไม่ได้แบ่งตามจำนวนบรรทัด
  • dict.skt และ warnings.skt เป็นชื่อไฟล์เสริมที่สงวนไว้
  • ห้ามใช้ไดเรกทอรีซอร์สหรือไดเรกทอรีบรรพบุรุษใดๆ เป็นไดเรกทอรีเอาต์พุต

ดู โหมดเอาต์พุต และ คู่มืออ้างอิงรูปแบบเอาต์พุต สำหรับรายละเอียด

Terminal window
codeknit parse ./src
codeknit parse ./src ./out --output-mode directory-tree
codeknit parse ./src --output-mode inline --format json --edges
Terminal window
codeknit graph show <input-path>
อาร์กิวเมนต์ จำเป็น คำอธิบาย
input-path ใช่ ไดเรกทอรีซอร์สหรือไฟล์ซอร์สเดียว
แฟล็ก ประเภท ค่าเริ่มต้น ค่าที่อนุญาต คำอธิบาย
-o, --output string ./skeleton/codeknit-graph.html เส้นทางไฟล์ ไฟล์ HTML เอาต์พุต
--collect-test bool false — รวมไฟล์ทดสอบ
--workers int 0 (NumCPU) 0 หรือมากกว่า จำนวนสูงสุดของ goroutines การแยกวิเคราะห์พร้อมกัน
--verbose bool false — แสดงข้อมูลความคืบหน้า
--header-language string c c, cpp Parser ที่ใช้สำหรับไฟล์ .h
--include GLOB string, repeatable ทุกซอร์สที่รองรับ — รวมเส้นทางซอร์สที่ตรงกัน
--exclude GLOB string, repeatable ไม่มี — ไม่รวมเส้นทางหรือไดเรกทอรีที่ตรงกัน
--max-file-size BYTES int 10485760 0 ปิดการจำกัดขนาด ข้ามไฟล์ซอร์สที่มีขนาดใหญ่กว่า
--strict bool false — ล้มเหลวก่อนเขียนเอาต์พุตหากเกิดการสแกนหรือวินิจฉัยการแยกวิเคราะห์

คำสั่งนี้เขียนไฟล์ HTML ที่สมบูรณ์ในตัวและเปิดในเบราว์เซอร์เริ่มต้น ผู้ชมจะวาดความสัมพันธ์ที่แก้ไขแล้วและแสดงจำนวนความสัมพันธ์ที่ไม่แน่นอน

Terminal window
codeknit graph show ./src -o graph.html
Terminal window
codeknit graph analyze <input-path>
อาร์กิวเมนต์ จำเป็น คำอธิบาย
input-path ใช่ ไดเรกทอรีซอร์สหรือไฟล์ซอร์สเดียว
แฟล็ก ประเภท ค่าเริ่มต้น ค่าที่อนุญาต คำอธิบาย
-o, --output string ./skeleton/graph_analysis.skt เส้นทางไฟล์ ไฟล์ .skt เอาต์พุต
--collect-test bool false — รวมไฟล์ทดสอบ
--workers int 0 (NumCPU) 0 หรือมากกว่า จำนวนสูงสุดของ goroutines การแยกวิเคราะห์พร้อมกัน
--verbose bool false — แสดงข้อมูลความคืบหน้า
--fan-threshold int 10 — จำนวนขั้นต่ำของ fan-in หรือ fan-out ที่จะระบุสัญลักษณ์ hub
--god-threshold int 15 — จำนวนขั้นต่ำของ contains เส้นเชื่อมที่จะระบุ god class หรือฟังก์ชัน
--max-inheritance-depth int 5 — ระบุสายการสืบทอดที่ลึกกว่าค่านี้
--top-n int 30 0 = ไม่มีขีดจำกัด จำกัดส่วนเอาต์พุตที่จัดอันดับ
--betweenness-threshold float 0.001 — ค่าความสำคัญระหว่างness ขั้นต่ำที่จะรายงาน
--propagation-cutoff float 0.05 — ความน่าจะเป็นขั้นต่ำที่จะดำเนินการแพร่กระจายการเปลี่ยนแปลง
--header-language string c c, cpp Parser ที่ใช้สำหรับไฟล์ .h
--include GLOB string, repeatable ทุกซอร์สที่รองรับ — รวมเส้นทางซอร์สที่ตรงกัน
--exclude GLOB string, repeatable ไม่มี — ไม่รวมเส้นทางหรือไดเรกทอรีที่ตรงกัน
--max-file-size BYTES int 10485760 0 ปิดการจำกัดขนาด ข้ามไฟล์ซอร์สที่มีขนาดใหญ่กว่า
--strict bool false — ล้มเหลวก่อนเขียนเอาต์พุตหากเกิดการสแกนหรือวินิจฉัยการแยกวิเคราะห์

การวัดการพึ่งพาจะไม่รวมความสัมพันธ์ที่ไม่แน่นอนและข้อมูลเมตาไฟล์/รวม รายงานจะบันทึกจำนวนความสัมพันธ์ที่ถูกยกเว้น

Terminal window
codeknit graph analyze ./src -o analysis.skt --fan-threshold 15 --top-n 50
Terminal window
codeknit graph hotspots <input-path>
อาร์กิวเมนต์ จำเป็น คำอธิบาย
input-path ใช่ ไดเรกทอรีซอร์สภายใน Git repository
แฟล็ก ประเภท ค่าเริ่มต้น ค่าที่อนุญาต คำอธิบาย
-o, --output string ./skeleton/hotspots.skt เส้นทางไฟล์ ไฟล์เอาต์พุต
--format string skt skt, json รูปแบบเอาต์พุต
--since string 12mo ช่วงเวลา เช่น 180d, 12mo หรือ 2y ช่วงเวลาประวัติ
--max-commits int 2000 — จำนวนสูงสุดของคอมมิตที่จะตรวจสอบ
--max-files-per-commit int 50 — ไม่รวมคอมมิตที่มีการเปลี่ยนแปลงไฟล์มากกว่าค่านี้
--min-cochanges int 3 — จำนวนคอมมิตที่ใช้ร่วมกันขั้นต่ำที่จะรายงานการเชื่อมโยงชั่วคราว
--top-n int 30 — จำนวนสูงสุดของผลลัพธ์ต่อส่วน
--include-merges bool false — รวมคอมมิตการผสานในการวัดประวัติ
--collect-test bool false — รวมไฟล์ทดสอบ
--workers int 0 (NumCPU) 0 หรือมากกว่า จำนวนสูงสุดของ goroutines การแยกวิเคราะห์พร้อมกัน
--verbose bool false — แสดงข้อมูลความคืบหน้า
--header-language string c c, cpp Parser ที่ใช้สำหรับไฟล์ .h
--include GLOB string, repeatable ทุกซอร์สที่รองรับ — รวมเส้นทางซอร์สที่ตรงกัน
--exclude GLOB string, repeatable ไม่มี — ไม่รวมเส้นทางหรือไดเรกทอรีที่ตรงกัน
--max-file-size BYTES int 10485760 0 ปิดการจำกัดขนาด ข้ามไฟล์ซอร์สที่มีขนาดใหญ่กว่า
--strict bool false — ล้มเหลวก่อนเขียนเอาต์พุตหากเกิดการสแกนหรือวินิจฉัยการแยกวิเคราะห์

คำสั่งนี้รวมความถี่ของคอมมิต การเปลี่ยนแปลงบรรทัด และความใหม่เข้ากับ PageRank ระดับไฟล์ fan-in แบบส่งผ่าน และความสำคัญระหว่างness นอกจากนี้ยังรายงานการเชื่อมโยงชั่วคราวระหว่างไฟล์ที่เปลี่ยนแปลงไปด้วยกัน คอมมิตการผสานจะถูกยกเว้นโดยค่าเริ่มต้น

Terminal window
codeknit graph hotspots ./src --since 2y --format json -o hotspots.json
Terminal window
codeknit fingerprint <input-path>
อาร์กิวเมนต์ จำเป็น คำอธิบาย
input-path ใช่ ไดเรกทอรีซอร์สหรือไฟล์ซอร์สเดียว
แฟล็ก ประเภท ค่าเริ่มต้น ค่าที่อนุญาต คำอธิบาย
-o, --output string ./skeleton/fingerprints.skt เส้นทางไฟล์ ไฟล์ .skt เอาต์พุต
--min-similarity int 65 0–100 เปอร์เซ็นต์ความคล้ายคลึงขั้นต่ำที่จะรายงาน
--max-similarity int 95 0–100 เปอร์เซ็นต์ความคล้ายคลึงสูงสุดที่จะรายงาน
--show-all bool false — รวมส่วน [fingerprints] พร้อมข้อมูลโทเค็นดิบด้วย
--rerank bool false — ค้นหาเพื่อนบ้านเชิงความหมายและจัดอันดับใหม่ด้วยการฝัง Ollama ต้องการ ollama serve และ ollama pull qwen3-embedding:0.6b
--model string qwen3-embedding:0.6b ชื่อโมเดล Ollama โมเดลการฝัง Ollama ที่จะใช้กับ --rerank
--collect-test bool false — รวมไฟล์ทดสอบ
--workers int 0 (NumCPU) 0 หรือมากกว่า จำนวนสูงสุดของ goroutines การแยกวิเคราะห์พร้อมกัน
--verbose bool false — แสดงข้อมูลความคืบหน้า
--header-language string c c, cpp Parser ที่ใช้สำหรับไฟล์ .h
--include GLOB string, repeatable ทุกซอร์สที่รองรับ — รวมเส้นทางซอร์สที่ตรงกัน
--exclude GLOB string, repeatable ไม่มี — ไม่รวมเส้นทางหรือไดเรกทอรีที่ตรงกัน
--max-file-size BYTES int 10485760 0 ปิดการจำกัดขนาด ข้ามไฟล์ซอร์สที่มีขนาดใหญ่กว่า
--strict bool false — ล้มเหลวก่อนเขียนเอาต์พุตหากเกิดการสแกนหรือวินิจฉัยการแยกวิเคราะห์

ช่วงเริ่มต้น 65–95% จะไม่รวมการจับคู่ 100% ในการรายงานการจับคู่โทเค็นที่ปรับให้เป็นบรรทัดฐานที่ตรงกันทั้งหมด ให้ตั้งค่าขอบเขตทั้งสองเป็น 100:

Terminal window
codeknit fingerprint ./src --min-similarity 100 --max-similarity 100

ผู้สมัครที่มีโทเค็นที่ปรับให้เป็นบรรทัดฐานตรงกันทั้งหมดจะสมบูรณ์ เมื่อมีสัญลักษณ์ที่มีสิทธิ์ตั้งแต่ 500 ขึ้นไป ผู้สมัครรายการที่เกือบซ้ำอื่นๆ จะใช้การดึงข้อมูลเพื่อนบ้าน top-50 โดยประมาณ --rerank สามารถลบผู้สมัครที่มีโครงสร้างตรงกันทั้งหมดได้ ดู ความน่าเชื่อถือของการวิเคราะห์ สำหรับรายละเอียด

Terminal window
codeknit completion <shell>
อาร์กิวเมนต์ จำเป็น ค่าที่อนุญาต คำอธิบาย
shell ใช่ bash, zsh, fish, powershell Shell ที่จะสร้างสคริปต์เติมคำสั่ง

สคริปต์จะถูกเขียนไปยัง stdout

Terminal window
codeknit completion zsh >> ~/.zshrc