L'outil en ligne de commande

Contenu technique

Cette page s’adresse aux utilisateurs à l’aise avec un terminal. Tout ce que fait lqcli est également faisable depuis l’interface web — l’outil sert surtout à automatiser des tâches répétitives ou à extraire des données en masse.

lqcli est un petit programme qui pilote votre compte Louquillou depuis un terminal. Il affiche toujours ses résultats en JSON, ce qui le rend facile à enchaîner avec d’autres outils.

Installer

lqcli est un binaire unique, sans runtime ni dépendance système à installer. Les archives pour macOS (Apple Silicon et Intel), Linux et Windows sont sur la page de téléchargement.

Décompressez l’archive et placez le binaire dans un répertoire de votre PATH :

tar xzf lqcli-macos-arm64.tar.gz
sudo mv lqcli /usr/local/bin/
lqcli --version

Les binaires ne sont pas signés

Au premier lancement, macOS refuse un exécutable téléchargé depuis le web. Levez la mise en quarantaine :

xattr -d com.apple.quarantine /usr/local/bin/lqcli

Sur Windows, SmartScreen affiche un avertissement : passez par Informations complémentaires, puis Exécuter quand même.

Chaque archive est publiée avec son empreinte SHA-256, dans le fichier SHA256SUMS de la même version. Vérifiez-la avant d’exécuter le binaire.

Vérifiez ensuite que tout répond :

lqcli health

Se connecter

Deux réglages pilotent l’outil, en variables d’environnement ou en options :

Variable	Option	Rôle
LOUQUILLOU_API_URL	--api-url	L’adresse du service. Par défaut https://api.louquillou.com, l’API de production ; pour cet environnement, utilisez https://api.louquillou.com.
LOUQUILLOU_TOKEN	--token	Votre jeton de connexion.

Connectez-vous avec vos identifiants habituels, puis conservez le jeton :

export LOUQUILLOU_API_URL=https://api.louquillou.com

export LOUQUILLOU_TOKEN=$(
lqcli auth login --email vous@example.com --password 'votre-mot-de-passe' \
| jq -r .access_token
)

Toutes les commandes sauf health et auth login nécessitent ce jeton.

Attention

Le jeton donne accès à votre compte. Ne le placez pas dans un script versionné et évitez de taper votre mot de passe directement dans la ligne de commande : il resterait dans l’historique de votre terminal.

Les commandes

L’outil s’organise par ressource, sur le modèle lqcli <ressource> <action>.

Ressource	Ce qu’elle couvre
auth	Créer un compte, se connecter, consulter son profil, se déconnecter
dashboard	Le récapitulatif de votre compte
alerts	Lister les alertes, les marquer comme lues
properties	Vos biens, leur photo de couverture, leurs baux et paiements
tenants	Les locataires d’un bien
leases	Le bail d’un locataire, sa génération en PDF, son envoi et sa conformité
payments	Les paiements d’un bail
receipts	Les quittances d’un bail, leur génération et leur lien de téléchargement
charges	La régularisation annuelle des charges
revisions / irl	La révision des loyers
reminders	Les relances d’impayés
deadlines	Les échéances à venir
sepa	Le prélèvement automatique et les mandats
billing / plan	Votre abonnement et votre facturation
onboarding	La mise en route de votre compte
documents	Consulter, modifier, téléverser et télécharger vos documents

Presque toute l’API est couverte : 88 points d’entrée sur 90. Les deux exceptions sont des adresses techniques qui n’ont pas de sens en ligne de commande — la page d’autorisation présentée au locataire et le retour automatique de Stripe.

Quelques exemples :

# Vos biens, filtrés
lqcli properties list --city Paris

# Les locataires d'un bien
lqcli tenants list <identifiant-du-bien>

# Générer une quittance
lqcli receipts generate <identifiant-du-bail> '{"month": "2026-03"}'

Ajoutez --help à n’importe quel niveau pour obtenir la liste exacte des options : lqcli properties --help.

Envoyer un corps JSON

Partout où une commande attend des données, trois écritures sont acceptées : le JSON directement entre guillemets, un fichier précédé de @, ou l’entrée standard avec -.

lqcli charges create <identifiant-du-bail> '{"year": 2026}'
lqcli charges set-actual <identifiant> @charges.json
jq -n '{charges: [{category: "eau", amount: 120.00}]}' | lqcli charges set-actual <identifiant> -

Attention

Les montants s’écrivent en nombres, pas en texte : {"rent_amount": 800.00} et non {"rent_amount": "800.00"}.

Téléverser un document

lqcli documents upload --file bail.pdf --metadata '{"title": "Bail", "category": "contract"}'

Le type de fichier est déduit de l’extension ; l’option --content-type permet de le forcer. Les catégories acceptées sont diagnostic, photo, receipt, contract et other.

Enchaîner avec d’autres outils

Comme la sortie est du JSON, jq permet d’extraire ce qui vous intéresse :

# Les noms de tous vos biens
lqcli properties list | jq '.data[].name'

# Les paiements en attente d'un bail
lqcli payments list <identifiant-du-bail> --status en_attente | jq '.data[]'

Les résultats partent sur la sortie standard et les messages d’information sur la sortie d’erreur, ce qui permet de rediriger proprement l’un sans l’autre.

Voir aussi

• L’API Louquillou
• Les documents d’un bien
• Les quittances