nimbuspulse-client 0.4.0

NimbusPulse API client
Documentation

nimbuspulse-client

Rust SDK for the NimbusPulse coordinator API.

Install

Add the crate to your project:

cargo add nimbuspulse-client

Usage

use nimbuspulse_client::Client;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let client = Client::new(std::env::var("NIMBUSPULSE_API_KEY")?);
    let servers = client.get_servers().await?;

    println!("servers: {}", servers.len());

    Ok(())
}

Implemented Capabilities

  • Health checks
  • Create, fetch, update, start, stop, restart, full restart, update, delete, and reactivate servers
  • Runtime lookup, chat retrieval, and resource metrics
  • Mod config retrieval, installation changes, and uninstallation changes
  • Server log retrieval
  • File listing, directory creation, upload, download, move, and delete
  • Mission upload, add, delete, select, and start
  • DCS pause / resume, settings save, kick, ban, and chat send
  • SRS client listing, kick, and ban for servers with the SRS mod installed
  • Webconsole execution for servers with the webconsole mod installed
  • Trigger create, list, and delete

Trigger management is not stable yet and will change in the future.

Development

cargo check

Repository

The monorepo root README contains the cross-language overview: