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.3.tar.gz (12.2 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.3-py3-none-any.whl (17.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: katalon_cli-0.1.3.tar.gz
  • Upload date:
  • Size: 12.2 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.3.tar.gz
Algorithm Hash digest
SHA256 e4e0b281cf7338d9ed191458239b5bf1d0d78dd5e6d047e811b0db6cbc216fd7
MD5 dcb9ea6e2cf9ec4276ef5f4084f3d288
BLAKE2b-256 8950ab97839ab757a1e6f09c841b475f6728fdb9dfdcf8de6ad4142b65d0db8a

See more details on using hashes here.

Provenance

The following attestation bundles were made for katalon_cli-0.1.3.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.3-py3-none-any.whl.

File metadata

  • Download URL: katalon_cli-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 17.2 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f9c5e04d892491bbace12f71f6114e591637120fe95a2f0e4f9d3c55ee7ac81d
MD5 f5fafd57d5d50c040d578dbf7825fcde
BLAKE2b-256 c2402448cf951472fc7406643f266c8e83b48d1badee376418be41d6629227be

See more details on using hashes here.

Provenance

The following attestation bundles were made for katalon_cli-0.1.3-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

0.1.4

2 files

This release

0.1.3 This release

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