https://github.com/powershellweb/websocket

Work with WebSockets in PowerShell
https://github.com/powershellweb/websocket

container powershell powershell-module websocket websocket-client

Last synced: about 1 month ago
JSON representation

Work with WebSockets in PowerShell

• Host: GitHub
• URL: https://github.com/powershellweb/websocket
• Owner: PowerShellWeb
• License: mit
• Created: 2024-11-27T05:10:17.000Z (about 2 months ago)
• Default Branch: main
• Last Pushed: 2024-12-07T00:27:11.000Z (about 2 months ago)
• Last Synced: 2024-12-14T18:16:05.153Z (about 1 month ago)
• Topics: container, powershell, powershell-module, websocket, websocket-client
• Language: PowerShell
• Homepage: https://websocket.powershellweb.com/
• Size: 101 KB
• Stars: 8
• Watchers: 1
• Forks: 1
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


    



# WebSocket

Work with WebSockets in PowerShell

WebSocket is a small PowerShell module that helps you work with WebSockets.

It has a single command:  Get-WebSocket.

Because `Get` is the default verb in PowerShell, you can just call it `WebSocket`.

## WebSocket Container

You can use the WebSocket module within a container:

~~~powershell

docker pull ghcr.io/powershellweb/websocket

docker run -it ghcr.io/powershellweb/websocket

~~~

### Installing and Importing

~~~PowerShell

Install-Module WebSocket -Scope CurrentUser -Force

Import-Module WebSocket -Force -PassThru

~~~

### Get-WebSocket

To connect to a websocket and start listening for results, use [Get-WebSocket](Get-WebSocket.md)

~~~PowerShell

# Because get is the default verb, we can just say `WebSocket`

# The `-Watch` parameter will continually watch for results

websocket wss://jetstream2.us-east.bsky.network/subscribe?wantedCollections=app.bsky.feed.post -Watch

~~~

To stop watching a websocket, simply stop the background job.

### More Examples

#### Get-WebSocket Example 1

~~~powershell

# Create a WebSocket job that connects to a WebSocket and outputs the results.

Get-WebSocket -WebSocketUri "wss://localhost:9669/"

~~~

 #### Get-WebSocket Example 2

~~~powershell

# Get is the default verb, so we can just say WebSocket.

# `-Watch` will output a continous stream of objects from the websocket.

# For example, let's Watch BlueSky, but just the text.        

websocket wss://jetstream2.us-west.bsky.network/subscribe?wantedCollections=app.bsky.feed.post -Watch |

    % { 

        $_.commit.record.text

    }

~~~

 #### Get-WebSocket Example 3

~~~powershell

# Watch BlueSky, but just the text and spacing

$blueSkySocketUrl = "wss://jetstream2.us-$(

    'east','west'|Get-Random

).bsky.network/subscribe?$(@(

    "wantedCollections=app.bsky.feed.post"

) -join '&')"

websocket $blueSkySocketUrl -Watch | 

    % { Write-Host "$(' ' * (Get-Random -Max 10))$($_.commit.record.text)$($(' ' * (Get-Random -Max 10)))"}

~~~

 #### Get-WebSocket Example 4

~~~powershell

websocket wss://jetstream2.us-east.bsky.network/subscribe?wantedCollections=app.bsky.feed.post

~~~

 #### Get-WebSocket Example 5

~~~powershell

# Watch BlueSky, but just the emoji

websocket jetstream2.us-east.bsky.network/subscribe?wantedCollections=app.bsky.feed.post -Tail |

    Foreach-Object {

        $in = $_

        if ($in.commit.record.text -match '[\p{IsHighSurrogates}\p{IsLowSurrogates}]+') {

            Write-Host $matches.0 -NoNewline

        }

    }

~~~

 #### Get-WebSocket Example 6

~~~powershell

$emojiPattern = '[\p{IsHighSurrogates}\p{IsLowSurrogates}\p{IsVariationSelectors}\p{IsCombiningHalfMarks}]+)'

websocket wss://jetstream2.us-west.bsky.network/subscribe?wantedCollections=app.bsky.feed.post -Tail |

    Foreach-Object {

        $in = $_

        $spacing = (' ' * (Get-Random -Minimum 0 -Maximum 7))

        if ($in.commit.record.text -match "(?>(?:$emojiPattern|\#\w+)") {

            $match = $matches.0                    

            Write-Host $spacing,$match,$spacing -NoNewline

        }

    }

~~~

 #### Get-WebSocket Example 7

~~~powershell

websocket wss://jetstream2.us-east.bsky.network/subscribe?wantedCollections=app.bsky.feed.post -Watch |

    Where-Object {

        $_.commit.record.embed.'$type' -eq 'app.bsky.embed.external'

    } |

    Foreach-Object {

        $_.commit.record.embed.external.uri

    }

~~~

 #### Get-WebSocket Example 8

~~~powershell

# BlueSky, but just the hashtags

websocket wss://jetstream2.us-west.bsky.network/subscribe?wantedCollections=app.bsky.feed.post -WatchFor @{

    {$webSocketoutput.commit.record.text -match "\#\w+"}={

        $matches.0

    }                

}

~~~

 #### Get-WebSocket Example 9

~~~powershell

# BlueSky, but just the hashtags (as links)

websocket wss://jetstream2.us-west.bsky.network/subscribe?wantedCollections=app.bsky.feed.post -WatchFor @{

    {$webSocketoutput.commit.record.text -match "\#\w+"}={

        if ($psStyle.FormatHyperlink) {

            $psStyle.FormatHyperlink($matches.0, "https://bsky.app/search?q=$([Web.HttpUtility]::UrlEncode($matches.0))")

        } else {

            $matches.0

        }

    }

}

~~~

 #### Get-WebSocket Example 10

~~~powershell

websocket wss://jetstream2.us-west.bsky.network/subscribe?wantedCollections=app.bsky.feed.post -WatchFor @{

    {$args.commit.record.text -match "\#\w+"}={

        $matches.0

    }

    {$args.commit.record.text -match '[\p{IsHighSurrogates}\p{IsLowSurrogates}]+'}={

        $matches.0

    }

}

~~~