Zum Hauptinhalt springen
quiCkLI

Ein kleiner Ort, um CLI-Design zu lernen

Erstelle Kommandozeilen-Tools, die du verstehst.

quiCkLI ist ein minimales Lern-Framework für Python-Kommandozeilenanwendungen.

hello.py
from quickli import Application, Argument
from quickli import load_json, load_yaml, render_json

app = Application(name="profile")

@app.entrypoint(arguments=[Argument("payload")])
def normalize(payload: str) -> str:
data = load_json(payload) if payload.lstrip().startswith(("{", "[")) else load_yaml(payload)
return render_json(data)

$ python profile.py "name: Ada" → {"name": "Ada"}

Lernen durch Bauen

Das Wesentliche, ohne den Lärm.

quickli hält die Kernideen sichtbar: registriere einen Handler, beschreibe seine Eingaben und dispatche explizite Kommandozeilen-Token.

01

Kleine Bausteine

Lerne Application, Command, Argument und Option – ein Konzept nach dem anderen.

02

Lesbares Python

Verwende Dekoratoren und normale Funktionen, um Tools zu erstellen, die leicht zu verstehen sind.

03

Raum zum Erkunden

Beginne mit einem kleinen Beispiel und füge dann Konvertierung, Validierung und Unterbefehle hinzu.

Neu bei quickli?

Beginne mit der Dokumentation.

Folge dem Kurzleitfaden, führe das Beispiel aus und nutze den Quellcode als Referenz.

Einleitung lesen

Zum Projekt hinzufügen

Starte dort, wo du bist.

Füge quickli einem bestehenden Git-Projekt hinzu oder erstelle ein neues Projekt zum Ausprobieren.

Bestehendes Projekt

quickli zu Git hinzufügen

Behalte dein aktuelles Projekt und installiere quickli in seiner virtuellen Umgebung.

Terminal
pip install quickli
Neues Projekt

Workspace initialisieren

Erstelle ein kleines Git-Projekt und füge quickli als erste Abhängigkeit hinzu.

Terminal
mkdir my-cli && cd my-cli
git init
python -m venv .venv
source .venv/bin/activate
python -m pip install quickli

Lieber eine geführte Einführung? Weiter zu dem Einstiegsleitfaden.