Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/poshbotio/PoshBot
Powershell-based bot framework
https://github.com/poshbotio/PoshBot
bot bot-framework bots chatbot chatbot-framework chatbots chatops devops powershell
Last synced: about 2 months ago
JSON representation
Powershell-based bot framework
- Host: GitHub
- URL: https://github.com/poshbotio/PoshBot
- Owner: poshbotio
- License: mit
- Created: 2017-01-04T07:49:41.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-05-21T08:05:46.000Z (7 months ago)
- Last Synced: 2024-10-29T17:26:12.524Z (about 2 months ago)
- Topics: bot, bot-framework, bots, chatbot, chatbot-framework, chatbots, chatops, devops, powershell
- Language: PowerShell
- Homepage:
- Size: 5.1 MB
- Stars: 539
- Watchers: 34
- Forks: 108
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# PoshBot
| Azure Pipelines | GitHub Actions | Documentation | PS Gallery | License |
|-----------------|----------------|---------------|------------|---------|
[![Azure Pipelines Build Status][azure-pipeline-badge]][azure-pipeline-build] | [![GitHub Actions Status][github-actions-badge]][github-actions-build] | [![Documentation Status][docs-badge]][docs] | [![PowerShell Gallery][psgallery-badge]][psgallery] | [![License][license-badge]][license]
---
Supporting PoshBot
PoshBot is a MIT-licensed open source project. Ongoing development is made possible thanks to the support of sponsors.
If you'd like to become a sponsor, you can do so through [GitHub Sponsors](https://github.com/users/devblackops/sponsorship) or [Patreon](https://www.patreon.com/bePatron?u=10352866).
Silver Sponsors
---
Want some in-depth guides? Check out [ChatOps the Easy Way](https://leanpub.com/chatops-the-easy-way) on [Leanpub](https://leanpub.com/)!
# Introduction
PoshBot is a chat bot written in [PowerShell](https://msdn.microsoft.com/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.
## What Can PoshBot Do?
Pretty much anything you want :) No seriously.
PoshBot executes functions or 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.
## Documentation
Detailed documentation can be found at [ReadTheDocs](http://poshbot.readthedocs.io/en/latest/).
## Building PoshBot
See [Building PoshBot](./building.md) for documentation on how to build PoshBot from source.
## Changelog
Detailed changes for each release are documented in the [release notes](https://github.com/poshbotio/poshbot/releases).
## [YouTube] PowerShell Summit 2018 - Invoke-ChatOps: Level up and change your culture with chat and PowerShell
[](https://youtu.be/Mrs49IdnSHc)
## Quickstart
To get started now, get a SLACK-API-TOKEN for your bot:
[https://my.slack.com/services/new/bot](https://my.slack.com/services/new/bot)
```powershell
# 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 = @('')
CommandPrefix = '!'
LogLevel = 'Info'
BackendConfiguration = @{
Name = 'SlackBackend'
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:
```powershell
# Create a Slack backend
$backendConfig = @{Name = 'SlackBackend'; Token = ''}
$backend = New-PoshBotSlackBackend -Configuration $backendConfig
# Create a PoshBot configuration
$pbc = New-PoshBotConfiguration -BotAdmins @('') -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.12.0 poshbot
Function Get-PoshBotConfiguration 0.12.0 poshbot
Function Get-PoshBotStatefulData 0.12.0 poshbot
Function New-PoshBotCardResponse 0.12.0 poshbot
Function New-PoshBotConfiguration 0.12.0 poshbot
Function New-PoshBotDiscordBackend 0.12.0 poshbot
Function New-PoshBotFileUpload 0.12.0 poshbot
Function New-PoshBotInstance 0.12.0 poshbot
Function New-PoshBotMiddlewareHook 0.12.0 poshbot
Function New-PoshBotScheduledTask 0.12.0 poshbot
Function New-PoshBotSlackBackend 0.12.0 poshbot
Function New-PoshBotTeamsBackend 0.12.0 poshbot
Function New-PoshBotTextResponse 0.12.0 poshbot
Function Remove-PoshBotStatefulData 0.12.0 poshbot
Function Save-PoshBotConfiguration 0.12.0 poshbot
Function Set-PoshBotStatefulData 0.12.0 poshbot
Function Start-PoshBot 0.12.0 poshbot
Function Stop-Poshbot 0.12.0 poshbot
```
[azure-pipeline-badge]: https://dev.azure.com/devblackops/PoshBot/_apis/build/status/PoshBot-CI
[azure-pipeline-build]: https://dev.azure.com/devblackops/PoshBot/_build/latest?definitionId=3
[github-actions-badge]: https://github.com/poshbotio/PoshBot/workflows/CI/badge.svg
[github-actions-build]: https://github.com/poshbotio/PoshBot/actions
[docs-badge]: https://readthedocs.org/projects/poshbot/badge/?version=latest
[docs]: http://poshbot.readthedocs.io/en/latest/
[psgallery-badge]: https://img.shields.io/powershellgallery/dt/poshbot.svg
[psgallery]: https://www.powershellgallery.com/packages/poshbot
[license-badge]: https://img.shields.io/github/license/poshbotio/poshbot.svg
[license]: https://www.powershellgallery.com/packages/poshbot