katalon-cli

Installer & Updater für Katalon Collections Production-Instanzen. Verwaltet eine Instanz unter einem Zielverzeichnis (z.B. /opt/katalon/) — pullt gepinnte Release-Images, generiert compose.yaml, macht Backups vor jedem Update, kann rollbacken.

Installation

curl -LsSf https://astral.sh/uv/install.sh | sh
uv tool install katalon-cli

Nutzung

katalon install              # interaktiver Setup-Wizard (Rich-Prompts + Progress)
katalon start / stop / status
katalon update                # interaktives Update, Backup zuerst immer
katalon rollback               # letztes Backup einspielen
katalon doctor                 # Docker, Diskspace, Ports prüfen
katalon backup                 # manuelles Backup
katalon logs [service]

Alle Befehle: --dir PATH (default /opt/katalon). install/update fragen interaktiv (Auswahl über rich.prompt), update/rollback haben --yes zum Überspringen der Rückfrage.

/opt/katalon gehört root — katalon install scheitert dort ohne Vorbereitung mit "Permission denied". sudo katalon install funktioniert i.d.R. nicht (sudo hat eigenes PATH, findet das per uv tool installierte katalon nicht). Zwei Optionen:

# a) anderes Zielverzeichnis, kein root nötig
katalon install --dir ~/katalon

# b) bei /opt/katalon bleiben: Verzeichnis vorab anlegen und dem User geben
sudo mkdir -p /opt/katalon
sudo chown $USER:$USER /opt/katalon
katalon install --dir /opt/katalon

Entwicklung

uv sync
uv run katalon --help
uv run pytest

Architektur

  • core/state.py — installation.json, Single Source of Truth für laufende Version.
  • core/release.py — GitHub-Release-Metadaten (katalon-release.json Asset), 1h Cache.
  • core/compose_gen.py + templates/compose.yaml.j2 + templates/nginx.conf.j2 — rendert compose.yaml
    • nginx.conf aus Version + TLS-Modus; erzeugt bei tls_mode=standalone ein selbstsigniertes Zertifikat unter <dir>/certs/ (eigenes Zertifikat dort ablegen, um es zu ersetzen). install fragt zusätzlich MEDIA_ROOT ab und legt <dir>/compose.override.yaml.example an (instanzspezifische Overrides — umbenennen zu compose.override.yaml, wird automatisch eingebunden und bei Updates nicht angefasst). Optionale Env-Vars (Admin-Login, SMTP, Geonames, …) landet auskommentiert in .env.
  • core/backup.py — pg_dump vor jedem Update; Rollback restauriert Dump statt alembic downgrade.
  • core/docker.py — dünner docker compose-Subprocess-Wrapper.
  • main.py — Typer-Commands, interaktive Teile über rich.prompt/rich.progress.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.1.5)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for karkraeg from gravatar.com karkraeg

Credits

Author: Karl Krägelin

Requires

Python >=3.12

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

katalon_cli-0.1.4.tar.gz (13.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

katalon_cli-0.1.4-py3-none-any.whl (18.7 kB view details)

Uploaded Python 3

File details

Details for the file katalon_cli-0.1.4.tar.gz.

File metadata

  • Download URL: katalon_cli-0.1.4.tar.gz
  • Upload date:
  • Size: 13.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for katalon_cli-0.1.4.tar.gz
Algorithm Hash digest
SHA256 3513c6aee2ded71f5a3b9459baf8b9bfce14dd2e9d6ebce5fdbed18e889dea79
MD5 c94cbc3c2831a6bd8511bf33480e1f4e
BLAKE2b-256 0125b578c7763703e3529924554788d2d75223dde56e5f522fdf619f81117078

See more details on using hashes here.

Provenance

The following attestation bundles were made for katalon_cli-0.1.4.tar.gz:

Publisher: release.yml on katalon-collections/katalon-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file katalon_cli-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: katalon_cli-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 18.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for katalon_cli-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 799251faca32cc245255ac390d52e21014753edad8d49daef8e41c11914f996d
MD5 f5f58a28770277a170caa37b424cfa6b
BLAKE2b-256 2fe83559d0df6e49c84c2d64a9383ca047bbbd8c45a92cbfb07aa250b6471a50

See more details on using hashes here.

Provenance

The following attestation bundles were made for katalon_cli-0.1.4-py3-none-any.whl:

Publisher: release.yml on katalon-collections/katalon-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.1.5

2 files

This release

0.1.4 This release

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page