hdmx — helpdesk-CLI-et
hdmx er en kommandolinjeklient for helpdesken i én binærfil. Den pakker det offentlige GraphQL-API-et inn i lettvinte kommandoer etter mønsteret ressurs-og-verb, slik at både KI-agenter og mennesker kan styre helpdesken fra et terminalvindu eller et skript i stedet for fra nettleseren.
Den er utformet for agenter først, mennesker deretter: hver kommando kjører ikke-interaktivt, hver datakommando kan sende ut en strukturert --json-konvolutt, feil ramser opp de gyldige verdiene de forventet, og et maskinlesbart kommandoskjema lar en agent lære hele flaten i ett kall og gjenbruke den på tvers av mange oppgaver.
CLI-et leveres fra sitt eget repositorium, github.com/mirasvit/hdmx — det er ikke en del av helpdeskens kodebase. Helpdesksiden leverer bare det offentlige API-et og de personlige tilgangstokenene som hdmx autentiserer seg mot. README-en i det repositoriet er den levende sannhetskilden for gjeldende kommandoliste; denne siden gir oversikten og beskriver kontrakten den hviler på.
Installasjon
go install github.com/mirasvit/hdmx/cmd/hdmx@latest
For hver utgivelse publiseres ferdigbygde binærfiler (Linux, macOS, Windows), en Homebrew-tap og et container-image. hdmx version skriver ut versjonen, byggedatoen og API-skjemaversjonen binærfilen er bygget mot.
Autentisering
hdmx autentiserer seg med et personlig tilgangstoken — se Offentlig API → Autentisering. Opprett et token selv i agentappen under Settings → API tokens; det har scopes, en obligatorisk IP-tillatelsesliste og en utløpsdato.
hdmx auth login --host helpdesk.example.com --subdomain acme --token hdmx_…
hdmx auth status
hdmx auth logout
Tokenet lagres i operativsystemets nøkkelring. For CI og containere overstyrer tre miljøvariabler den lagrede profilen uten noen interaktiv forespørsel: HDMX_HOST, HDMX_SUBDOMAIN, HDMX_TOKEN.
Flere leietakere håndteres med profiler — én profil samler en vert, et subdomene, et token og et sett standardverdier:
hdmx profile save acme --host helpdesk.example.com --subdomain acme --token hdmx_…
hdmx profile use acme
hdmx --profile other tickets list
Hva den kan gjøre
Kommandoflaten følger ressursfamiliene i helpdesken. De viktigste områdene:
| Område | Hva du kan gjøre |
|---|---|
| Saker | liste, søke, triagere, vise, oppdatere, tildele, sette status / prioritet / etiketter, slå sammen, slette |
| Meldinger | lese meldingene i en sak, poste et offentlig svar eller et internt notat |
| Chat | liste og vise samtaler, sende, lukke, gjenåpne, bli med, forlate, merke som lest |
| Kunder | liste, søke, vise, opprette, oppdatere, slå sammen |
| Grunndata | avdelinger, statuser, prioriteter, postbokser, etiketter, brukere |
| Rapporter | oversikt, volum, svartider, per agent, etterslep, fordelinger |
| Konto | gjeldende konto, metadata, gjeldende bruker |
To bekvemmeligheter er verdt å nevne:
- Navn i stedet for ID-er. Flagg godtar enten et lesbart navn eller en ID —
--status open,--assignee [email protected]eller den rå identifikatoren slås alle opp. Sammenhengen mellomlagres lokalt per konto. - Navngitte arbeidsflyter.
hdmx tickets triagekjører standard triageringsvisning (åpne, ikke lukkede, ikke funksjonsønsker, sortert etter prioritet) uten at den som kaller må sette sammen filteret på nytt hver gang.
Utdata og sikkerhet
- Strukturert som standard for maskiner. Utdata som sendes videre i en pipe, er en JSON-konvolutt (
ok,data,summary,warnings,error,meta); en TTY får lesbar Markdown.--jqfiltrerer JSON underveis. Data går til stdout, diagnostikk til stderr. - Feil som lærer bort. Når en verdi avvises, nevner feilen de gyldige verdiene og en konkret neste kommando — en feil status gir for eksempel listen over faktiske statuser og et eksempel på et kall.
- Begrensede svar. Listekommandoer har en standard sidestørrelse og et hardt tak; når utdata kuttes, sier svaret fra og forteller hvordan du kan snevre inn. Det holder svarene innenfor tokenbudsjettet til en agent.
- Prøvekjøring og godkjenningsporter. Enhver mutasjon godtar
--dry-run(viser operasjonen og den forventede virkningen uten å sende den). Destruktive handlinger krever--force; å poste kundevendte meldinger eller interne notater krever--approve.
Lære flaten å kjenne
Hjelpen finnes i tre lag, rettet mot tre målgrupper:
hdmx <command> --help— fritekst med bruk og eksempler (for mennesker).hdmx agent-context— et versjonert, maskinlesbart skjema over hver kommando, hvert flagg, hver enum, feilkode, standardverdi og navngitt arbeidsflyt (for agenter som binder seg til en stabil flate).hdmx skills— sammensetningsoppskrifter som binder flere kommandoer til en navngitt kjørebok (for eksempel en triager-og-svar-flyt).
Forholdet til det offentlige API-et
hdmx er den første ikke-nettleserbaserte forbrukeren av helpdeskens offentlige API. Alt den gjør går gjennom det samme PAT-autentiserte GraphQL-endepunktet, under de samme scopene og ratebegrensningene — det finnes ingen privilegert bakdør. API-skjemaet er kontrakten; hdmx bygges mot en fastlåst API-versjon og følger API-ets utfasingsretningslinje, slik at en CLI-utgivelse fortsetter å virke mot ethvert kompatibelt (ikke-brytende) serverskjema.