contentful cli

CLI ที่น่าพอใจ

เครื่องมืออินเทอร์เฟซบรรทัดคำสั่งของ Contentful ใช้ฟีเจอร์ Contentful โดยตรงจาก CLI ของคุณ

Contentful มอบโครงสร้างพื้นฐานเนื้อหาสำหรับทีมดิจิทัลเพื่อขับเคลื่อนเนื้อหาในเว็บไซต์ แอพ และอุปกรณ์ Contentful ต่างจาก CMS ตรงที่ถูกสร้างขึ้นเพื่อผสานรวมกับกลุ่มซอฟต์แวร์สมัยใหม่ โดยมีศูนย์กลางสำหรับเนื้อหาที่มีโครงสร้าง การจัดการที่มีประสิทธิภาพและ API การจัดส่ง และเว็บแอปที่ปรับแต่งได้ซึ่งช่วยให้นักพัฒนาและผู้สร้างเนื้อหาสามารถจัดส่งผลิตภัณฑ์ดิจิทัลได้เร็วขึ้น

คุณสมบัติ

• เริ่มต้นใช้งาน Contentful ด้วยคำสั่ง init
• จัดการพื้นที่ - แสดงรายการ สร้าง ลบ...
• ส่งออก Space ของคุณเป็นไฟล์ JSON
• นำเข้าพื้นที่ของคุณจากไฟล์ JSON
• ดำเนินการสคริปต์การโยกย้ายที่เขียนใน Contentful Migration DSL
• สร้างสคริปต์การโยกย้ายสำหรับ Contentful Migration DSL จากพื้นที่ที่มีอยู่
• สร้างพื้นที่ของคุณด้วยข้อมูลตัวอย่าง
• จัดการการติดตั้งส่วนขยายในพื้นที่
• เข้าสู่ระบบและออกจากระบบอย่างปลอดภัยด้วยบริการ OAuth ของเรา
• ค้นหาคำสั่งที่มีอยู่ทั้งหมดในส่วนเอกสาร

☁️การติดตั้ง

ตรวจสอบให้แน่ใจว่าคุณได้ติดตั้ง Node LTS แล้ว

จากนั้นใช้ npm หรือเส้นด้าย:

npm install -g contentful-cli
# Or
yarn global add contentful-cli

โปรดทราบว่าสำหรับเวอร์ชันที่ไม่ใช่สแตนด์อโลน คุณต้องมี Node LTS เพื่อใช้ CLI

การใช้งาน

ใช้พารามิเตอร์ --help เพื่อแสดงส่วนวิธีใช้สำหรับเครื่องมือ CLI หรือรวมกับคำสั่งเฉพาะเพื่อรับส่วนวิธีใช้สำหรับคำสั่งนั้น

contentful --help
# Or
contentful space --help

เอกสารประกอบ

เอกสารรายละเอียดเพิ่มเติมสำหรับทุกคำสั่งสามารถพบได้ในส่วนเอกสาร

การใช้เครื่องมือ CLI กับพร็อกซี

คุณสามารถบันทึกการกำหนดค่าพร็อกซีใน .contentfulrc.json ของคุณได้ทาง:

contentful config add --proxy user:auth@host:port

นอกจากนี้เรายังเคารพตัวแปรสภาพแวดล้อม http(s)_proxy :

https_proxy=user:auth@host:port contentful

เมื่อมีการกำหนดค่าพร็อกซีหลายรายการ จะมีลำดับความสำคัญในรูปแบบนี้:

1. http_proxy มีความสำคัญมากกว่า .contentfulrc.json
2. https_proxy มีความสำคัญมากกว่า .contentfulrc.json
3. https_proxy มีความสำคัญมากกว่า http_proxy

การกำหนดค่า CLI สำหรับการใช้งานในสหภาพยุโรป

คุณสามารถแทนที่การกำหนดค่าโฮสต์ใน .contentfulrc.json ของคุณได้ทาง:

contentful config add --host api.eu.contentful.com

จากนั้นคำสั่งที่ตามมาจะใช้โฮสต์ของสหภาพยุโรป เช่น contentful login จะนำคุณเข้าสู่อินสแตนซ์ EU Contentful ของคุณ

⛑️ การแก้ไขปัญหา

• ไม่สามารถเชื่อมต่อกับ Contentful ผ่าน Proxy ของคุณได้ใช่ไหม ลองตั้งค่า rawProxy: true ใน .contentfulrc.json ของคุณผ่าน:

contentful config add --raw-proxy

การพัฒนา

1. ติดตั้งการพึ่งพา

   npm i

2. เพื่อหลีกเลี่ยงไม่ให้เวอร์ชันการพัฒนาขัดแย้งกับ Contentful CLI ที่ติดตั้งไว้แล้ว ให้เปลี่ยนชื่อคำสั่งใน package.json

     "bin": {
   -     "contentful": "bin/contentful.js"
   +     "ctfl": "bin/contentful.js"
     }

3. เชื่อมโยงเวอร์ชันท้องถิ่นของคุณและแฮ็คอย่างมีความสุข ?

   npm link

- การทดสอบ

การทดสอบบูรณาการ

หากต้องการรันการทดสอบการรวมภายในเครื่อง คุณจะต้องมีสิ่งต่อไปนี้:

1. ตั้งค่าตัวแปรสภาพแวดล้อมใน .jest/env.js (สามารถพบได้ใน 1Password)

    process . env . CONTENTFUL_INTEGRATION_TEST_CMA_TOKEN = '<cma_auth_token>'
   process . env . CLI_E2E_ORG_ID = '<organization_id>'

2. เรียกใช้พร็อกซี talkback เพื่อบันทึกและเล่นคำขอ http

   npm run talkback-proxy

3. ในเทอร์มินัลเชลล์อื่นให้รันการทดสอบที่คุณต้องการ

    # # Run all integration tests
   npm run test:jest
   # # Or run specific tests
   npx jest test/integration/cmds/space/ * --watch

การทดสอบหน่วย

เพียงเรียกใช้:

 # Run all unit tests
npm run test:unit:watch
# Or run specific tests
npx jest test/unit/cmds/ * --watch

ดูเอกสารประกอบการเล่นตลกสำหรับรายละเอียดเพิ่มเติมเกี่ยวกับการรันการทดสอบและแฟล็กเสริม

กำลังอัปเดตสแนปชอต

คุณอาจต้องอัปเดตสแนปชอตและการบันทึกเป็นสิ่งที่ท้าทาย

เคล็ดลับ: ทำการทดสอบโดยไม่มีการบันทึกเพื่ออัปเดตสแนปชอต

 npx jest test/integration/cmds/<path to the affected test file> --updateSnapshot

❓สนับสนุน

หากคุณประสบปัญหากับเครื่องมือนี้ โปรดแจ้งปัญหาที่นี่บน Github

หากคุณมีปัญหาอื่นๆ กับ Contentful ที่ไม่เกี่ยวข้องกับไลบรารีนี้ คุณสามารถติดต่อฝ่ายสนับสนุนลูกค้าได้

✍️ร่วมสมทบทุน

ดูการมีส่วนร่วม.md

ใบอนุญาต

เอ็มไอที