James
a9bc50465f
* fix debug url * fix `MatrixMessage` type * add `Remove-MatrixRoomMessage` * add `Get-Help` block |
||
|---|---|---|
| private | ||
| public | ||
| .gitignore | ||
| PSMatrix.psd1 | ||
| PSMatrix.psm1 | ||
| PSMatrixTypes.ps1xml | ||
| README.md | ||
README.md
PSMatrix
PowerShell module for interacting with the Matrix API
Installation
- Clone repo:
git clone https://github.com/Thumbscrew/PSMatrix.git
- Import module:
cd PSMatrix
Import-Module ./PSMatrix
Getting Started
- Create a
PSCredentialobject:
$creds = Get-Credential
PowerShell credential request
Enter your credentials.
User: username
Password for user username: **************
- Get an access token from your Matrix homeserver (this will be required for subsequent authenticated requests):
# DeviceDisplayName is optional and will default to "PSMatrix"
$token = New-MatrixAccessToken -ServerUrl "https://example.matrix.com" -Credentials $creds -DeviceDisplayName "PSMatrix"
Examples
Get a list Matrix rooms you've joined
$rooms = Get-MatrixJoinedRooms -ServerUrl "https://matrix.example.com" -AccessToken $token
Get all members of a joined room
Get-MatrixJoinedMembers -ServerUrl "https://matrix.example.com" -AccessToken $token -RoomId "!ehXvUhWNASUkSLvAGP:matrix.org"
Log out of your session
Remove-MatrixAccessToken -ServerUrl "https://matrix.example.com" -AccessToken $token