Git Product home page Git Product logo

poshbot's Introduction

PoshBot

Build status Documentation Status Gratipay

PoshBot is a chat bot written in PowerShell. It makes extensive use of classes introduced in PowerShell 5.0. PowerShell modules are loaded into PoshBot and instantly become available as bot commands. PoshBot currently supports connecting to Slack to provide you with awesome ChatOps goodness.

PoshBot logo

What Can PoshBot Do?

Pretty much anything you want :) No seriously. PoshBot executes functions/cmdlets from PowerShell modules. Use PoshBot to connect to servers and report status, deploy code, execute runbooks, query APIs, etc. If you can write it in PowerShell, PoshBot can execute it.

Detailed documentation can be found at ReadTheDocs

See Building PoshBot for documentation on how to build PoshBot from source.

[YouTube] PoshBot Demo at the Portland User Group on 2017-05-31

Alt text

Quickstart

To get started now, get a SLACK-API-TOKEN for your bot:

https://api.slack.com/bot-users

# Install the module from PSGallery
Install-Module -Name PoshBot -Repository PSGallery

# Import the module
Import-Module -Name PoshBot

# Create a bot configuration
$botParams = @{
    Name = 'name'
    BotAdmins = @('<SLACK-CHAT-HANDLE>')
    CommandPrefix = '!'
    LogLevel = 'Info'
    BackendConfiguration = @{
        Name = 'SlackBackend'
        Token = '<SLACK-API-TOKEN>'
    }
    AlternateCommandPrefixes = 'bender', 'hal'
}

$myBotConfig = New-PoshBotConfiguration @botParams

# Start a new instance of PoshBot interactively or in a job.
Start-PoshBot -Configuration $myBotConfig #-AsJob

Basic usage:

# Create a Slack backend
$backendConfig = @{Name = 'SlackBackend'; Token = '<SLACK-API-TOKEN>'}
$backend = New-PoshBotSlackBackend -Configuration $backendConfig

# Create a PoshBot configuration
$pbc = New-PoshBotConfiguration -BotAdmins @('<MY-SLACK-HANDLE>') -BackendConfiguration $backendConfig

# Save configuration
Save-PoshBotConfiguration -InputObject $pbc -Path .\PoshBotConfig.psd1

# Load configuration
$pbc = Get-PoshBotConfiguration -Path .\PoshBotConfig.psd1

# Create an instance of the bot
$bot = New-PoshBotInstance -Configuration $pbc -Backend $backend

# Start the bot
$bot.Start()

# Available commands
Get-Command -Module PoshBot

CommandType     Name                                               Version    Source
-----------     ----                                               -------    ------
Function        Get-PoshBot                                        0.9.0      poshbot
Function        Get-PoshBotConfiguration                           0.9.0      poshbot
Function        Get-PoshBotStatefulData                            0.9.0      poshbot
Function        New-PoshBotCardResponse                            0.9.0      poshbot
Function        New-PoshBotConfiguration                           0.9.0      poshbot
Function        New-PoshBotFileUpload                              0.9.0      poshbot
Function        New-PoshBotInstance                                0.9.0      poshbot
Function        New-PoshBotScheduledTask                           0.9.0      poshbot
Function        New-PoshBotSlackBackend                            0.9.0      poshbot
Function        New-PoshBotTextResponse                            0.9.0      poshbot
Function        Remove-PoshBotStatefulData                         0.9.0      poshbot
Function        Save-PoshBotConfiguration                          0.9.0      poshbot
Function        Set-PoshBotStatefulData                            0.9.0      poshbot
Function        Start-PoshBot                                      0.9.0      poshbot
Function        Stop-Poshbot                                       0.9.0      poshbot

poshbot's People

Contributors

devblackops avatar jaapbrasser avatar joshuatee avatar markwragg avatar megamorf avatar michaeltlombardi avatar ramblingcookiemonster avatar rayterrill avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.