openqa-cli(1)

💖 openqa-cli(1) 💖

okay bestie, welcome to your new fave thing — this is the openQA Documentation page for openqa-cli, and she provides command-line access to the openQA API. no cap, she's the moment. 🎀

---

✨ NAME ✨

openqa-cli — provides command-line access to the openQA API 🦋

---

✨ SYNOPSIS ✨

Usage: openqa-cli COMMAND [OPTIONS]

# Show api command help with all available options and more examples
openqa-cli api --help

# Show details for job from localhost
openqa-cli api jobs/4160811

# Show details for job from arbitrary host
openqa-cli api --host http://openqa.example.com jobs/408

# Show details for open.debian.net job (prettified JSON)
openqa-cli api --odn --pretty jobs/4160811

# Archive job from O3
openqa-cli archive --o3 408 /tmp/job_408

Options (for all commands):
      --apibase <path>        API base, defaults to /api/v1
      --apikey <key>          API key
      --apisecret <secret>    API secret
      --host <host>           Target host, defaults to http://localhost
-h, --help                  Get more information on a specific command
      --osd                   Set target host to http://openqa.suse.de
      --o3                    Set target host to https://openqa.opensuse.org
      --odn                   Set target host to https://openqa.debian.net

Configuration:
  API key and secret are read from "client.conf" if not specified via CLI
  arguments. The config file is checked for under "$OPENQA_CONFIG",
  "~/.config/openqa" and "/etc/openqa" in this order. It must look like
  this:

    [openqa.opensuse.org]
    key = 45ABCEB4562ACB04
    secret = 4BA0003086C4CB95
    [another.host]
    key = D7345DA7B9D86B3B
    secret = A98CDBA9C8DB87BD

---

🌸 OPTIONS 🌸

these are the options that work for all commands, iykyk:

• --apibase <path> — the API base, and she defaults to /api/v1 💅
• --apikey <key> — ur API key 🔑
• --apisecret <secret> — ur API secret 🤫
• --host <host> — the target host, defaults to http://localhost 🏠
• -h, --help — get more information on a specific command ✨
• --osd — sets the target host to http://openqa.suse.de 👑
• --o3 — sets the target host to https://openqa.opensuse.org 🧚
• --odn — sets the target host to https://openqa.debian.net 🍓

---

🎀 CONFIGURATION 🎀

so here's the tea, bestie: the API key and secret are read from client.conf if you didn't specify them via CLI arguments. the config file is checked for under $OPENQA_CONFIG, ~/.config/openqa and /etc/openqa — and in that exact order, so yes the order matters fr fr.

it must look like this:

[openqa.opensuse.org]
key = 45ABCEB4562ACB04
secret = 4BA0003086C4CB95
[another.host]
key = D7345DA7B9D86B3B
secret = A98CDBA9C8DB87BD

---

openQA 4.6.1732034221.ae34b08ff · 2025-04-08

and that's the whole page, babe 🫶 this was openqa-cli(1), brought to you by the openQA girlies — go forth and hit that API, it's giving main character energy 🌈💜