Skip to main content

katalon-cli

Installer & Updater für Katalon Collections Production-Instanzen. Verwaltet eine Instanz unter einem frei gewählten Zielverzeichnis — 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 check-updates         # prüft nur, ob ein neues Release verfügbar ist
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]

install ohne --dir fragt das Zielverzeichnis interaktiv ab. Nach erfolgreicher Einrichtung wird der absolute Pfad benutzerweit in ~/.config/katalon/instance gespeichert. Bei gesetztem, absolutem XDG_CONFIG_HOME liegt die Datei stattdessen unter $XDG_CONFIG_HOME/katalon/instance. Das Konfigurationsverzeichnis wird bei Bedarf angelegt. Alle weiteren Befehle verwenden den gespeicherten Pfad, unabhängig vom Arbeitsverzeichnis. Ohne gespeicherten Pfad ist der Default auf allen Plattformen ~/katalon.

Alle Befehle unterstützen --dir PATH: überschreibt den Pfad nur für diesen Aufruf. Eine erfolgreiche neue Installation speichert ihr Zielverzeichnis als neuen Default. Bestehende Instanzen lassen sich weiterhin mit --dir verwenden; alternativ ihren absoluten Pfad als einzige Zeile in die Konfigurationsdatei eintragen. install/update fragen interaktiv (Auswahl über rich.prompt), update/rollback haben --yes zum Überspringen der Rückfrage.

katalon install --dir ~/meine-katalon-instanz
katalon start
katalon status

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). Enthält optional env_vars/deprecated_env_vars: install/update ergänzen neue Pflichtvariablen automatisch (Secret generieren oder Default übernehmen), fragen bei fehlendem Default interaktiv nach (--yes bricht dann ab), tragen neue optionale Variablen auskommentiert in .env ein und warnen vor veralteten Variablen, die noch in der .env stehen.
  • 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.

Metadata

Release files for katalon-cli 0.1.18

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for katalon-cli 0.1.18
File Size Uploaded Provenance Actions
katalon_cli-0.1.18.tar.gz 16.6 kB With provenance Details for katalon_cli-0.1.18.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for katalon-cli 0.1.18
File Interpreter ABI Platform Actions
katalon_cli-0.1.18-py3-none-any.whl Python 3 none any Details for katalon_cli-0.1.18-py3-none-any.whl

Total release size: 38.5 kB

Release files / katalon_cli-0.1.18.tar.gz

Download URL katalon_cli-0.1.18.tar.gz
Size 16.6 kB
Tags Source
SHA-256 checksum
How to use checksums
80b4c359a61651a50e5dcb1ba25f883e6229372f8d8b275fe60ce613a1678644
BLAKE2b-256 checksum
How to use checksums
5be5cfac906a3bedd344f3753ca6a5557e20e8100e962b795da859daff405e57
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.

Transparency log

Release files / katalon_cli-0.1.18-py3-none-any.whl

Download URL katalon_cli-0.1.18-py3-none-any.whl
Size 21.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c153dc5e1292be6078c921b92044fd17b7f79f130c026ff81dbdc32edd27f71a
BLAKE2b-256 checksum
How to use checksums
cc301789c6b09813ec416aaeb79a127129b27d83c46430ff05b41147f7da6bc7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.

Transparency log

Security for katalon-cli 0.1.18

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for katalon_cli-0.1.18.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 2, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.18 This release

2 release files Full provenance

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