contentful cli

CLI yang puas

Alat antarmuka baris perintah Contentful. Gunakan fitur Contentful langsung dari CLI Anda.

Contentful menyediakan infrastruktur konten bagi tim digital untuk mendukung konten di situs web, aplikasi, dan perangkat. Berbeda dengan CMS, Contentful dibuat untuk berintegrasi dengan tumpukan perangkat lunak modern. Ini menawarkan hub pusat untuk konten terstruktur, API manajemen dan pengiriman yang kuat, dan aplikasi web yang dapat disesuaikan yang memungkinkan pengembang dan pembuat konten mengirimkan produk digital lebih cepat.

Fitur

• Mulailah Contentful dengan perintah init .
• Kelola ruang - daftar, buat, hapus,...
• Ekspor ruang Anda ke file JSON.
• Impor ruang Anda dari file JSON.
• Jalankan skrip migrasi yang ditulis dalam Contentful Migration DSL
• Hasilkan skrip migrasi untuk DSL Migrasi Konten dari ruang yang ada.
• Benihkan ruang Anda dengan contoh data.
• Kelola pemasangan ekstensi di suatu ruang.
• Masuk dan keluar dengan aman dengan layanan OAuth kami.
• Temukan semua perintah yang tersedia di bagian dokumen.

☁️ Instalasi

Pastikan Anda telah menginstal Node LTS

Kemudian menggunakan npm atau benang:

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

Harap dicatat bahwa untuk versi non mandiri Anda memerlukan Node LTS untuk menggunakan CLI.

Penggunaan

Gunakan parameter --help untuk menampilkan bagian bantuan untuk alat CLI atau digabungkan dengan perintah tertentu untuk mendapatkan bagian bantuan untuk perintah tersebut.

contentful --help
# Or
contentful space --help

Dokumentasi

Dokumentasi lebih rinci untuk setiap perintah dapat ditemukan di bagian dokumen.

Menggunakan alat CLI dengan proxy

Anda dapat menyimpan konfigurasi proxy di .contentfulrc.json Anda melalui:

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

Kami juga menghormati variabel lingkungan http(s)_proxy :

https_proxy=user:auth@host:port contentful

Jika ada beberapa konfigurasi proksi, prioritasnya diambil dalam bentuk ini:

1. http_proxy lebih diutamakan daripada .contentfulrc.json
2. https_proxy lebih diutamakan daripada .contentfulrc.json
3. https_proxy lebih diutamakan daripada http_proxy

Mengonfigurasi CLI untuk penggunaan UE

Anda dapat mengganti konfigurasi host di .contentfulrc.json Anda melalui:

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

Maka perintah selanjutnya akan menggunakan host UE. Misalnya contentful login akan memasukkan Anda ke dalam instance Contentful UE Anda.

⛑️ Pemecahan masalah

• Tidak dapat terhubung ke Contentful melalui Proxy Anda? Coba pengaturan rawProxy: true di .contentfulrc.json Anda melalui:

contentful config add --raw-proxy

Perkembangan

1. Instal dependensi

   npm i

2. Untuk menghindari versi pengembangan bertabrakan dengan Contentful CLI yang sudah Anda instal, ubah nama perintah di package.json

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

3. Tautkan versi lokal Anda, dan selamat meretas?

   npm link

? Pengujian

Tes integrasi

Untuk menjalankan pengujian integrasi secara lokal, Anda memerlukan hal berikut:

1. Tetapkan variabel lingkungan di .jest/env.js (dapat ditemukan di 1Password)

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

2. Jalankan proxy komentar balik untuk merekam dan memutar permintaan http

   npm run talkback-proxy

3. Di shell terminal lain, jalankan tes pilihan Anda

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

Tes satuan

Cukup jalankan:

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

Lihat dokumentasi lelucon untuk detail selengkapnya tentang menjalankan pengujian dan tanda opsional.

Memperbarui Snapshot

Anda mungkin perlu memperbarui snapshot dan rekamannya sulit.

Tip: jalankan pengujian tanpa rekaman untuk memperbarui snapshot.

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

❓ Dukungan

Jika Anda mempunyai masalah dengan alat ini, silakan ajukan masalah di sini di Github.

Jika Anda memiliki masalah lain dengan Contentful yang tidak terkait dengan perpustakaan ini, Anda dapat menghubungi Dukungan Pelanggan.

✍️ Berkontribusi

Lihat KONTRIBUSI.md

Lisensi

MIT