Referensi Konfigurasi

🚀Referensi Konfigurasi

Reflow 1.0.2

Petakan konfigurasi Reflow bawaan ke perintah dan batas operasi yang memakainya.

Command.config/reflow/config.toml

📦Category

Konfigurasi

🚀Quick Command

[tool.reflow.*]

---

TOMLdefault perintahtarget repositori

---

Resolusi dan kepemilikan

Jika sebuah pengaturan memiliki opsi CLI yang sesuai, Reflow menentukan nilainya dalam urutan berikut:

1. Argumen CLI eksplisit
2. .config/reflow/config.toml
3. Default internal

File yang dibuat oleh reflow init dimiliki proyek target. Tinjau sebelum melakukan commit, dan jangan menaruh kredensial atau token di URL repositori atau nama image.

⚠️Pilih path atau URL—jangan keduanya

Di dalam [tool.reflow.repository], aktifkan hanya satu bentuk target. Jika path dan url ada bersamaan, Reflow melaporkan configuration error. Jika keduanya tidak ada, target kembali ke direktori kerja saat ini kecuali target CLI eksplisit diberikan.

Repositori dan Git

📋Pengaturan target

Property	Type	Description	Default	Required
repository.path	path	Direktori lokal yang sudah ada. Nilai relatif ditentukan dari direktori pemanggilan.	.	No
repository.url	URL Git	Repositori remote yang dimaterialisasi dalam clone sementara terkelola. Jangan masukkan kredensial.	tidak diatur	No
git.default_remote	string	Nama remote untuk penggantian tag remote dan push pemulihan release.	origin	No

Perintah	Target path	Target url	Cakupan persisten
reflow init	Didukung	Ditolak	File konfigurasi proyek
reflow tags convert local	Didukung	Ditolak	Tag ref lokal saja
reflow tags convert remote	Memakai remote checkout	Memakai clone sementara	Atomic push remote yang dijaga
reflow releases recover	Memakai remote checkout	Memakai clone sementara	Hapus dan push ulang tag remote terpilih
reflow dockerize	Memakai checkout sebagai sumber	Memakai clone sementara sebagai sumber	Operasi Docker dan registry

Nilai registry seperti github.image dan gitlab.image tidak pernah memilih repositori Git.

Eksekusi CLI Bersama

📋[tool.reflow.cli.execution]

Property	Type	Description	Default	Required
debug	boolean	Aktifkan output diagnostik terperinci ketika flag CLI tidak diberikan.	false	No
dry_run	boolean	Simulasikan perubahan lokal, remote, Docker, dan registry sambil tetap menjalankan discovery dan validasi.	false	No

📋[tool.reflow.cli.progress]

Property	Type	Description	Default	Required
enabled	boolean	Tampilkan spinner dan progress bar Rich. Pengaturan ini hanya mengubah presentasi, bukan perilaku live atau dry-run.	true	No

ℹ️Dry-run masih dapat membaca dan menulis log

Discovery Git atau provider yang read-only serta penyiapan clone sementara dapat berjalan saat dry-run. Logging diagnostik juga dapat menulis ke file log; perubahan persisten pada proyek, remote, Docker, dan registry tetap disimulasikan.

Inisialisasi

📋[tool.reflow.initialization]

Property	Type	Description	Default	Required
force	boolean	Perilaku overwrite default untuk reflow init ketika --force/--no-force tidak diberikan.	false	No
ask	boolean	Minta konfirmasi sebelum keputusan pembuatan atau penggantian yang didukung ketika --ask tidak diberikan.	false	No

Pengaturan ini hanya digunakan oleh reflow init. Perintah aktif menerima mode all dan config serta memerlukan target lokal persisten.

Konversi Tag

📋[tool.reflow.cli.tags.convert]

Property	Type	Description	Default	Required
target_format	semver | pep440	Format tujuan bersama untuk konversi tag lokal dan remote ketika --to tidak diberikan.	semver	No
yes	boolean	Lewati konfirmasi penggantian live setelah rencana lengkap ditampilkan. Dry-run tidak meminta konfirmasi.	false	No

Default yang sama dipakai oleh reflow tags convert local dan reflow tags convert remote; subperintah yang dipilih tetap menentukan apakah ref lokal atau remote yang dapat berubah.

Pemulihan Release dan Alias Deprecated

📋[tool.reflow.cli.releases.recover]

Property	Type	Description	Default	Required
delay	integer >= 0	Jeda dalam detik di antara operasi push ulang tag remote terpilih.	2	No
only_stable	boolean	Kecualikan tag prerelease saat memilih release yang dipulihkan.	false	No
limit	integer >= 1 | tidak diatur	Jumlah maksimum tag tanpa release yang dipilih.	tanpa batas	No

--yes untuk reflow releases recover hanya tersedia melalui CLI. Recovery memeriksa GitHub release, lalu menghapus dan push ulang tag remote terpilih untuk memicu kembali CI/CD berbasis tag; perintah ini tidak membuat release melalui API.

📋[tool.reflow.cli.tags.replay] (deprecated)

Property	Type	Description	Default	Required
delay	integer >= 0	Fallback lama ketika delay recovery kanonis tidak dikonfigurasi.	2	No
only_stable	boolean	Fallback lama untuk filter stable-only kanonis.	false	No
limit	integer >= 1 | tidak diatur	Fallback lama untuk limit recovery kanonis.	tanpa batas	No

Pertahankan nilai lama hanya selama migrasi konfigurasi. Konfigurasi dan automasi baru harus memakai [tool.reflow.cli.releases.recover] dan reflow releases recover.

Docker dan Image Registry

📋Publikasi container

Property	Type	Description	Default	Required
docker.provider	github | gitlab | both	Pilih tujuan registry terkonfigurasi yang dipakai reflow dockerize.	github	No
docker.keep_local_images	boolean	Pertahankan semua tagged image lokal dan jangan hapus image non-latest setelah push.	false	No
github.image	nama image	Tujuan GHCR, misalnya ghcr.io/acme/project. Wajib untuk github atau both.	placeholder template	No
gitlab.image	nama image	Tujuan GitLab Container Registry. Wajib untuk gitlab atau both.	placeholder template	No

reflow dockerize tidak memiliki flag provider atau image khusus perintah pada Reflow 1.0.2; atur nilai ini di TOML. Mode live melakukan build dan push satu image per tag repositori, menandai tag terurut terbaru sebagai latest, serta dapat menghapus image lokal non-latest.

Logging Console dan File

📋[tool.reflow.logging]

Property	Type	Description	Default	Required
level	log level	Ambang logging console; --log-level mengalahkan nilai ini.	INFO	No
markup	boolean	Aktifkan Rich markup pada logging console.	true	No
rich_tracebacks	boolean	Aktifkan rendering traceback Rich.	true	No
show_time	boolean	Tampilkan timestamp pada record log console.	false	No
show_level	boolean	Tampilkan label severity pada record log console.	false	No
console_format	format string	Format logging Python untuk record console.	%(message)s	No

📋[tool.reflow.logging.file]

Property	Type	Description	Default	Required
level	log level	Ambang logging file.	DEBUG	No
log_dir	path	Direktori untuk log persisten.	logs	No
log_file	nama file	Nama file log aktif.	reflow.log	No
max_bytes	ukuran	Rotasi log setelah mencapai ukuran perkiraan ini.	10MB	No
backup_count	integer	Jumlah file log hasil rotasi yang dipertahankan.	5	No
file_format	format string	Format logging Python untuk record file.	timestamp | level | logger | message	No

Jangan masukkan kredensial, token, atau URL yang mengandung secret ke dalam konfigurasi atau output diagnostik.

Contoh Target Minimal

Target lokal

toml

[tool.reflow.repository]
path = "../project"

[tool.reflow.cli.tags.convert]
target_format = "semver"
yes = false

Target URL remote

toml

[tool.reflow.repository]
url = "https://github.com/acme/project.git"

[tool.reflow.git]
default_remote = "origin"

Jangan gabungkan contoh path dan url dalam satu konfigurasi aktif.

ℹ️Gunakan key yang didukung secara tepat

Key yang tidak dikenal atau salah eja tidak menggantikan opsi CLI atau default yang didukung. Bandingkan file hasil inisialisasi dengan template Reflow 1.0.2 bawaan saat memperbarui konfigurasi proyek yang sudah ada.

🚀Related Commands

Commands commonly used together with this command.

Ringkasan Konfigurasi

Pahami precedence dan kepemilikan proyek.

Target Repositori

Pilih path atau URL dengan aman.

Ringkasan Perintah

Cocokkan konfigurasi dengan cakupan perubahan perintah.