Struct HarmontClient 

pub struct HarmontClient { /* private fields */ }

A configured client for the Harmont Cloud API.

Construct with HarmontClient::new (prod) or HarmontClient::with_base_url (self-hosted / local dev). The bearer token is attached to every request via a preconfigured reqwest::Client.

Implementations

impl HarmontClient

pub fn new(token: impl Into<String>) -> Self

Create a client against the production API.

pub fn with_base_url(token: impl Into<String>, base: impl Into<String>) -> Self

Create a client against an explicit base URL.

Panics

Panics if token contains characters that are invalid for an HTTP header value (e.g. non-ASCII or control characters).

pub fn anonymous(base: impl Into<String>) -> Self

Create a client with no credentials, for anonymous endpoints (the CLI auth flows: redeem/claim). Sends no Authorization header.

pub fn base_url(&self) -> &str

The configured base URL.

pub fn raw(&self) -> &RawClient

The raw generated client, for endpoints the high-level API does not wrap.

impl HarmontClient

pub async fn submit_build(&self, b: NewBuild) -> Result<Build>

Submit a build from a local worktree. Returns the created Build.

pub async fn submit_repo_build(&self, b: NewRepoBuild) -> Result<Build>

Submit a build addressed by (repo_name, source_slug) — the hm run path. Returns the created Build, whose pipeline_slug is the resolved global slug (use it to watch/cancel). Errors carry the server’s structured code/message, including a missing-pipeline 404.

pub async fn get_build( &self, org: &str, pipeline: &str, number: i64, ) -> Result<Build>

Fetch a build by its pipeline-scoped number.

pub async fn list_jobs( &self, org: &str, pipeline: &str, number: i64, ) -> Result<Vec<Job>>

List the jobs of a build.

pub async fn cancel_build( &self, org: &str, pipeline: &str, number: i64, ) -> Result<()>

Cancel a running build.

impl HarmontClient

pub async fn log_token( &self, org: &str, pipeline: &str, number: i64, ) -> Result<LogToken>

Mint a build-scoped HMAC log token (authorizes every job in the build).

pub async fn stream_job_logs( &self, log_base: &str, job_id: Uuid, token: &str, ) -> Result<impl Stream<Item = Result<LogEvent>>>

Stream a single job’s logs until the done event. log_base is the host serving /v0/jobs/{id}/logs (the web edge, e.g. the API base); token comes from Self::log_token.

impl HarmontClient

pub async fn redeem_code(&self, code: &str) -> Result<String>

Redeem a paste code for a bearer token (headless login).

The user obtains the paste code from the SPA (which calls the authed GET /api/v0/auth/cli/code endpoint while logged in) and types it into the CLI. Single-use, expires in 5 minutes.

pub async fn claim_token(&self, nonce: &str) -> Result<String>

Claim a loopback-parked token by nonce (browser login).

The CLI generates a random nonce, opens the browser to the SPA, and polls this endpoint until the token appears (the SPA calls the authed POST /api/v0/auth/cli/transfer endpoint). Single-use, expires in 60 seconds. Callers should retry on crate::HarmontError::Api with code cli_code_invalid until the token is claimed or the window closes.

pub async fn create_api_token(&self, description: &str) -> Result<String>

Mint a personal API token (requires an authenticated client).

The raw token is returned once and never retrievable again. Store it securely (e.g. in the system keychain or ~/.config/harmont/token).

Trait Implementations

impl Clone for HarmontClient

fn clone(&self) -> HarmontClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HarmontClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.