Skip to main content

Crate gitfox_client

Crate gitfox_client 

Source
Expand description

gitfox-client — a Rust client for the GitFox API.

This crate knows about HTTP and about GitFox. It knows nothing about terminals, tables, exit codes or configuration files. That separation is what lets gf (the CLI) and, later, gf-mcp (the MCP server) share one implementation instead of the MCP server shelling out to the CLI.

use gitfox_client::GitFoxClient;

let client = GitFoxClient::builder("https://git.example.com")
    .token(Some("…".to_string()))
    .build()?;
let user = client.auth().current_user().await?;
println!("{}", user.label());

Re-exports§

pub use client::DEFAULT_RETRIES;
pub use client::DEFAULT_TIMEOUT_SECS;
pub use client::GitFoxClient;
pub use client::GitFoxClientBuilder;
pub use client::Query;
pub use client::RawResponse;
pub use client::is_retryable_method;
pub use error::Error;
pub use error::Result;
pub use models::Check;
pub use models::CheckCountSummary;
pub use models::CiStatus;
pub use models::CodeComment;
pub use models::Commit;
pub use models::Content;
pub use models::ContentEntry;
pub use models::CreateGitspace;
pub use models::CreatePullRequest;
pub use models::CreateRepository;
pub use models::Execution;
pub use models::FileDiff;
pub use models::Gitspace;
pub use models::GitspaceInstance;
pub use models::Identity;
pub use models::LABEL_COLORS;
pub use models::Label;
pub use models::LabelAssignment;
pub use models::LabelInput;
pub use models::LabelValue;
pub use models::LabelValueInfo;
pub use models::LicenseTemplate;
pub use models::LogLine;
pub use models::Membership;
pub use models::MergeMethod;
pub use models::MergePullRequest;
pub use models::MergeResult;
pub use models::Pipeline;
pub use models::Principal;
pub use models::PublicKey;
pub use models::PullRequest;
pub use models::PullRequestActivity;
pub use models::PullRequestCheck;
pub use models::PullRequestChecks;
pub use models::PullRequestLabel;
pub use models::PullRequestLabels;
pub use models::PullRequestReviewer;
pub use models::PullRequestState;
pub use models::PullRequestStats;
pub use models::RepoRef;
pub use models::Repository;
pub use models::ReviewDecision;
pub use models::Rule;
pub use models::Signature;
pub use models::Space;
pub use models::SpaceSecret;
pub use models::Stage;
pub use models::Step;
pub use models::SystemConfig;
pub use models::UpdatePullRequest;
pub use models::User;
pub use models::decode_base64;
pub use models::encode_base64;
pub use models::label_color;
pub use models::label_color_hex;
pub use pull_request::PullRequestFilter;
pub use repo::RepoSort;

Modules§

auth
Authentication endpoints.
client
The HTTP client every other module and both front-ends (CLI, and later MCP) go through.
error
Typed errors for the GitFox API client.
labels
Label endpoints.
models
Domain models owned by the client.
pipeline
Pipeline / CI endpoints.
principal
Principal (user / service account) lookup.
pull_request
Pull request endpoints.
repo
Repository endpoints.
rules
Protection rules and gitspaces.
spaces
Spaces, and the things that live in them: secrets. Also the caller’s own account resources — SSH keys — and the instance’s system configuration.

Structs§

Method
The Request Method (VERB)