Skip to content

Geogboe/bearded-avenger-sdk-posh

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PoshSTINGAR

Table of Contents

Project Overview

This module provides functions to interfaces with the STINGAR REST API. See https://github.com/csirtgadgets/bearded-avenger/wiki about the details of this project.

How to Install

Eventually, this module will be available via PowerShellGallery, after which you can install it like this:

Install-Module -Name PoshSTINGAR -Repository PSGallery -Force -Scope CurrentUser0

For the moment, simple clone the code locally and add the module to your module path like this:

git clone git@github.com:Geogboe/bearded-avenger-sdk-posh.git
cd .\bearded-avenger-sdk-posh
Import-Module .\Src\PoshSTINGAR.psd1 -Force

# Optionally, if you don't want to clone directly into your module path, create a symbolic link
$MyModulePath = "$env:HOME\Documents\WindowsPowerShell\Modules"
New-Item -ItemType SymbolicLink -Path "$MyModulePath\PoshSTINGAR" -Target ".\Src"
Import-Module PoshSTINGAR -Force

Basic Usage

Import-Module PoshSTINGAR -Force
Get-Command -Module PoshSTINGAR

Roadmap

  • Add support for /GET Search and /GET Filter paths
  • Add support for remaining paths
  • Create a contribution guide
  • Create a build from source guide
  • Create PSGallery deployment and build process

Directory Structure

/Src/Private: Contains functions that are inteded to be 'private'--or will not show up in the list of exported cmdlets for this module but are available for any for use by any other function/cmdlet

/Src/Models: Contains scripts that contain classes used to define object structures.

/Src/Public: Contains scripts which hold function/cmdlets that are intended to be Public or Exported meaning they will be callable outside of the module scope.

/Templates: Contains Plaster templates to assist with creating code for use in the module. Items like new Public and Private functions.

/Test: Contains Pester tests

/Rules: Contains custom PSScriptAnalyzer rules

/Deploy: Contains PSDeploy scripts

/Docs: Contains automatically generated function and cmdlet documentation.

/.build.ps1: This is a build script used by Invoke-Build

Build From Source

WIP...

Contributing

WIP...