Referensi perintah Amazon Q CLI

Bagian ini memberikan referensi komprehensif untuk semua perintah CLI Pengembang Amazon Q dan argumennya. Gunakan referensi ini untuk memahami opsi yang tersedia untuk setiap perintah dan sintaks yang tepat.

Untuk bantuan dengan perintah apa pun, Anda dapat menggunakan --help bendera:


q [COMMAND] --help

Argumen global

Argumen berikut tersedia dengan perintah Amazon Q CLI apa pun:

Argumen global
Pendapat	Bentuk pendek	Deskripsi
`--verbose`	`-v`	Meningkatkan verbositas logging. Dapat diulang untuk keluaran yang lebih bertele-tele:`-v`,,, `-vv` `-vvv` `-vvvv`
`--help`	`-h`	Tampilkan informasi bantuan untuk perintah
`--version`	`-V`	Tampilkan informasi versi
`--help-all`		Cetak bantuan untuk semua subperintah

Commands

Bagian berikut menjelaskan setiap perintah Amazon Q CLI dan argumen yang tersedia.

q obrolan

Mulai sesi obrolan interaktif dengan Amazon Q. Ketika tidak ada subperintah yang ditentukan, q defaultnya. q chat

Sintaksis:


q chat [OPTIONS] [INPUT]

q argumen obrolan
Pendapat	Bentuk pendek	Deskripsi
`--no-interactive`		Cetak respons pertama ke STDOUT tanpa mode interaktif. Ini akan gagal jika prompt meminta izin untuk menggunakan alat, kecuali juga `--trust-all-tools` digunakan
`--resume`	`-r`	Lanjutkan percakapan sebelumnya dari direktori ini
`--profile`		Profil konteks untuk digunakan
`--trust-all-tools`		Izinkan model menggunakan alat apa pun untuk menjalankan perintah tanpa meminta konfirmasi
`--trust-tools`		Percaya hanya seperangkat alat yang ditentukan. Berikan daftar nama alat yang dipisahkan koma. Contoh:`--trust-tools=fs_read,fs_write`. Untuk tidak mempercayai alat, gunakan `--trust-tools=`
`INPUT`		Pertanyaan pertama yang diajukan (argumen posisi)

Contoh:


q chat
q chat "How do I list files in Linux?"
q chat --no-interactive --trust-all-tools "Show me the current directory"
q chat --resume
q chat --profile my-profile "Help me with AWS CLI"

q terjemahkan

Terjemahkan instruksi bahasa alami ke perintah shell yang dapat dieksekusi menggunakan AI.

Sintaksis:


q translate [OPTIONS] [INPUT...]

q menerjemahkan argumen
Pendapat	Bentuk pendek	Deskripsi
`--n`	`-n`	Jumlah penyelesaian yang akan dihasilkan (harus ≤5)
`INPUT`		Deskripsi bahasa alami dari perintah yang ingin Anda hasilkan (argumen posisi)

Contoh:


q translate "list all files in the current directory"
q translate "find all Python files modified in the last week"
q translate "compress all log files older than 30 days"

q dokter

Memperbaiki dan mendiagnosis masalah instalasi dan konfigurasi umum dengan Amazon Q.

Sintaksis:


q doctor [OPTIONS]

q argumen dokter
Pendapat	Bentuk pendek	Deskripsi
`--all`	`-a`	Jalankan semua tes dokter, tanpa perbaikan
`--strict`	`-s`	Kesalahan pada peringatan

Contoh:


q doctor
q doctor --all
q doctor --strict

pembaruan q

Perbarui aplikasi Amazon Q ke versi terbaru.

Sintaksis:


q update [OPTIONS]

q memperbarui argumen
Pendapat	Bentuk pendek	Deskripsi
`--non-interactive`	`-y`	Jangan meminta konfirmasi
`--relaunch-dashboard`		Luncurkan kembali ke dasbor setelah pembaruan. Default benar
`--rollout`		Menggunakan peluncuran

Contoh:


q update
q update --non-interactive
q update --rollout

tema q

Dapatkan atau atur tema visual untuk menu dropdown pelengkapan otomatis. Ini mempengaruhi tampilan jendela popup yang menunjukkan penyelesaian perintah.

Sintaksis:


q theme [OPTIONS] [THEME]

argumen tema q
Pendapat	Deskripsi
`--list`	Daftar semua tema yang tersedia
`--folder`	Tampilkan jalur direktori tema
`THEME`	Nama tema yang akan ditetapkan. Tema bawaan meliputi:`dark`,`light`, `system` (argumen posisi)

Contoh:


q theme --list
q theme --folder
q theme dark
q theme light
q theme system

Catatan: Perubahan tema mempengaruhi jendela popup autocomplete. Anda mungkin perlu memicu saran pelengkapan otomatis untuk melihat perubahan visual.

q integrasi

Kelola integrasi sistem untuk Amazon Q.

Sintaksis:


q integrations [SUBCOMMAND] [OPTIONS]

q integrasi subperintah

q integrasi subperintah
Subperintah	Deskripsi
`install`	Instal integrasi. Mendukung `--silent` (`-s`) untuk menekan pesan status
`uninstall`	Copot pemasangan integrasi. Mendukung `--silent` (`-s`) untuk menekan pesan status
`reinstall`	Instal ulang integrasi. Mendukung `--silent` (`-s`) untuk menekan pesan status
`status`	Periksa status integrasi. Mendukung `--format` (`-f`) untuk format output

q sebaris

Kelola saran sebaris (teks hantu) yang muncul langsung di baris perintah Anda saat Anda mengetik. Untuk informasi selengkapnya, lihat Fitur bantuan baris perintah

Sintaksis:


q inline [SUBCOMMAND] [OPTIONS]

q subperintah inline

q subperintah inline
Subperintah	Deskripsi
`enable`	Aktifkan saran sebaris yang muncul saat Anda mengetik
`disable`	Nonaktifkan saran sebaris
`status`	Menunjukkan apakah saran sebaris diaktifkan atau dinonaktifkan
`set-customization`	Pilih model kustomisasi yang akan digunakan. Secara opsional menentukan ARN kustomisasi
`show-customizations`	Tampilkan model kustomisasi yang tersedia. Mendukung `--format` (`-f`) untuk format output

Contoh:


q inline enable
q inline disable
q inline status
q inline set-customization
q inline set-customization arn:aws:codewhisperer:us-east-1:123456789012:customization/example
q inline show-customizations
q inline show-customizations --format json

Otentikasi dengan Amazon Q menggunakan AWS Builder ID (gratis) atau IAM Identity Center (Pro).

Sintaksis:


q login [OPTIONS]

q argumen login
Pendapat	Deskripsi
`--license`	Jenis lisensi. Pilihan: `free` (untuk Builder ID), `pro` (untuk Identity Center)
`--identity-provider`	URL penyedia identitas (untuk Pusat Identitas)
`--region`	Wilayah AWS (untuk Pusat Identitas)
`--use-device-flow`	Selalu gunakan alur OAuth perangkat untuk otentikasi. Berguna saat pengalihan browser tidak dapat ditangani

Contoh:


q login
q login --license free
q login --license pro --identity-provider https://my-company.awsapps.com/start --region us-east-1
q login --use-device-flow

q logout

Keluar dari sesi Amazon Q Anda.

Sintaksis:


q logout

Perintah ini tidak membutuhkan argumen tambahan.

q whoami

Menampilkan informasi tentang pengguna saat ini dan status otentikasi.

Sintaksis:


q whoami [OPTIONS]

q argumen whoami
Pendapat	Bentuk pendek	Deskripsi
`--format`	`-f`	Format keluaran. Opsi: `plain` (default),`json`, `json-pretty`

profil q

Tampilkan profil yang terkait dengan pengguna Pusat Identitas IAM saat ini. Perintah ini hanya tersedia untuk pengguna Pro.

Sintaksis:


q profile

Perintah ini tidak membutuhkan argumen tambahan.

pengaturan q

Kelola pengaturan konfigurasi Amazon Q. Untuk informasi rinci tentang manajemen pengaturan, lihatMengonfigurasi setelan Amazon Q.

Sintaksis:


q settings [SUBCOMMAND] [OPTIONS] [KEY] [VALUE]

argumen pengaturan q
Pendapat	Bentuk pendek	Deskripsi
`--delete`	`-d`	Hapus setelan
`--format`	`-f`	Format keluaran. Opsi: `plain` (default),`json`, `json-pretty`
`KEY`		Kunci pengaturan (argumen posisi)
`VALUE`		Menetapkan nilai (argumen posisi)

q pengaturan subperintah

q pengaturan subperintah
Subperintah	Deskripsi
`open`	Buka file pengaturan di editor default Anda
`all`	Daftar semua pengaturan saat ini. Mendukung `--format` opsi

q diagnostik

Jalankan tes diagnostik untuk memecahkan masalah penginstalan dan konfigurasi Amazon Q.

Sintaksis:


q diagnostic [OPTIONS]

q argumen diagnostik
Pendapat	Bentuk pendek	Deskripsi
`--format`	`-f`	Format keluaran. Opsi: `plain` (default),`json`, `json-pretty`
`--force`		Paksa output diagnostik terbatas

masalah q

Buat GitHub masalah baru untuk umpan balik Amazon Q atau laporan bug.

Sintaksis:


q issue [OPTIONS] [DESCRIPTION...]

argumen masalah q
Pendapat	Bentuk pendek	Deskripsi
`--force`	`-f`	Pembuatan masalah paksa
`DESCRIPTION`		Deskripsi masalah (argumen posisi)

versi q

Tampilkan informasi versi dan secara opsional menampilkan changelog.

Sintaksis:


q version [OPTIONS]

argumen versi q
Pendapat	Deskripsi
`--changelog[=VERSION]`	Tampilkan changelog. Gunakan `--changelog` untuk versi saat ini, `--changelog=all` untuk semua versi, atau `--changelog=x.x.x` untuk versi tertentu

q mcp

Kelola server Model Context Protocol (MCP). Untuk informasi rinci tentang MCP, lihatMenggunakan MCP dengan Pengembang Amazon Q.

Sintaksis:


q mcp [SUBCOMMAND] [OPTIONS]

q mcp tambahkan

Tambahkan atau ganti server MCP yang dikonfigurasi.

Sintaksis:


q mcp add [OPTIONS]

q mcp tambahkan argumen
Pendapat	Deskripsi
`--name`	Nama untuk server (wajib)
`--command`	Perintah yang digunakan untuk meluncurkan server (wajib)
`--scope`	Dimana untuk menambahkan server. Pilihan:`workspace`, `global`
`--env`	Variabel lingkungan untuk digunakan saat meluncurkan server. Format: `key1=value1,key2=value2`
`--timeout`	Batas waktu peluncuran server dalam milidetik
`--force`	Menimpa server yang ada dengan nama yang sama

q mcp hapus

Hapus server dari konfigurasi MCP.

Sintaksis:


q mcp remove [OPTIONS]

q mcp hapus argumen
Pendapat	Deskripsi
`--name`	Nama server yang akan dihapus (wajib)
`--scope`	Cakupan untuk dihapus dari. Pilihan:`workspace`, `global`

daftar q mcp

Daftar server MCP yang dikonfigurasi.

Sintaksis:


q mcp list [SCOPE]

argumen daftar q mcp
Pendapat	Deskripsi
`SCOPE`	Lingkup ke daftar. Opsi:`workspace`, `global` (argumen posisi)

q mcp impor

Impor konfigurasi server dari file lain.

Sintaksis:


q mcp import [OPTIONS] [SCOPE]

argumen impor q mcp
Pendapat	Deskripsi
`--file`	File untuk mengimpor konfigurasi server dari (wajib)
`--force`	Menimpa server yang ada dengan nama yang sama
`SCOPE`	Cakupan untuk diimpor ke. Opsi:`workspace`, `global` (argumen posisi)

status q mcp

Dapatkan status server MCP yang dikonfigurasi.

Sintaksis:


q mcp status [OPTIONS]

argumen status q mcp
Pendapat	Deskripsi
`--name`	Nama server untuk mendapatkan status (wajib)

File log

Amazon Q Developer CLI memelihara file log yang dapat berguna untuk pemecahan masalah. Log ini disimpan secara lokal di mesin Anda dan tidak dikirim ke AWS.

Lokasi berkas log:

macOS: $TMPDIR/qlog/
Linux: $XDG_RUNTIME_DIR atau TMPDIR atau /tmp

Tingkat log dapat dikontrol dengan mengatur variabel Q_LOG_LEVEL lingkungan. Nilai yang valid adalah:

error: Hanya pesan kesalahan (default)
warn: Peringatan dan pesan kesalahan
info: Pesan informasi, peringatan, dan kesalahan
debug: Debug, informasi, peringatan, dan pesan kesalahan
trace: Semua pesan termasuk informasi jejak terperinci

Awas

File log mungkin berisi informasi sensitif dari percakapan dan interaksi Anda dengan Amazon Q, termasuk jalur file, cuplikan kode, dan output perintah. Meskipun log ini hanya disimpan di mesin lokal Anda dan tidak dikirim ke AWS, Anda harus berhati-hati saat berbagi file log dengan orang lain.

Contoh pengaturan level log (untuk tujuan debugging):


# For bash/zsh
export Q_LOG_LEVEL=debug
q chat

# For fish
set -x Q_LOG_LEVEL debug
q chat

Awas Javascript dinonaktifkan atau tidak tersedia di browser Anda.

Untuk menggunakan Dokumentasi AWS, Javascript harus diaktifkan. Lihat halaman Bantuan browser Anda untuk petunjuk.

Konvensi Dokumen

Pengaturan

Bantuan baris perintah

Referensi perintah Amazon Q CLI

Argumen global

Commands

q obrolan

q terjemahkan

q dokter

pembaruan q

tema q

q integrasi

q integrasi subperintah

q sebaris

q subperintah inline

q masuk

q logout

q whoami

profil q

pengaturan q

q pengaturan subperintah

q diagnostik

masalah q

versi q

q mcp

q mcp tambahkan

q mcp hapus

daftar q mcp

q mcp impor

status q mcp

File log

Awas