Crate ghastoolkit

GitHub Advanced Security (GHAS) Toolkit is a library for interacting with various GitHub’s API and features. The main goal of this library is to provide a simple and easy to use interface with these features.

Features

There are a few features that are currently supported by this library:

• CodeQL
  • CodeQL CLI
  • CodeQL Database(s)
• GitHub Advanced Security APIs
  • Code Scanning
  • Secret Scanning

Usage

use ghastoolkit::{GitHub, Repository};

#[tokio::main]
async fn main() {
    // Initialize GitHub using default environment variables or github.com
    let github = GitHub::default();
    println!("GitHub :: {}", github);

    let repository = Repository::parse("geekmasher/ghastoolkit-rs@main")
        .expect("Failed to create Repository");
    println!("Repository :: {}", repository);
}

Re-exports

• pub use errors::GHASError;
• pub use octokit::github::GitHub;
• pub use octokit::repository::Repository;
• pub use codeql::packs::CodeQLPack;
• pub use codeql::packs::CodeQLPackType;
• pub use codeql::packs::CodeQLPacks;
• pub use codeql::CodeQL;
• pub use codeql::CodeQLDatabase;
• pub use codeql::CodeQLDatabases;
• pub use supplychain::Dependencies;
• pub use supplychain::Dependency;

Modules

• codeql
  CodeQL module is used to interact with CodeQL CLI and databases
• codescanning
  Code Scanning module is used to interact with GitHub’s Code Scanning API
• errors
  GHASToolkit errors module contains all the errors that can be thrown by the library
• octokit
  GitHub Octokit client for interacting with GitHub’s API endpoints Octokit is a GitHub API client for Rust.
• supplychain
  GHASToolkit supplychain module contains all the supplychain related functions and helpers
• utils
  GHASToolkit utils module contains all the utility functions and helpers