Cortlet WebSocket CLI
Cortlet WebSocket CLI is a lightweight command-line tool for working directly with WebSocket endpoints.
It is designed for developers who want a fast way to connect to, inspect, test, and debug WebSocket servers from the terminal.
cortlet-ws
Development status
Cortlet WebSocket CLI is currently in development.
The command structure and behavior may still change before the first public release.
This includes:
- command names
- command options
- output formatting
- error messages
- installation methods
- reconnect behavior
- inspection output
- platform support
Stable documentation will be published alongside the public release.
What the CLI is for
The CLI is intended for tasks such as:
- connecting to a WebSocket endpoint
- sending messages
- testing connectivity
- inspecting a connection
- testing reconnect behavior
- debugging WebSocket servers
- checking endpoint responses from the terminal
It can be used independently from the hosted Cortlet Gateway.
Planned commands
The current command set is expected to include:
cortlet-ws connect
cortlet-ws send
cortlet-ws ping
cortlet-ws inspect
cortlet-ws reconnect-test
cortlet-ws help
cortlet-ws clear
These commands may change before release.
Example
A basic connection may eventually look like:
cortlet-ws connect wss://example.com/socket
The CLI would open a WebSocket connection and display connection activity directly in the terminal.
Exact output and command behavior are still being finalized.
Connect
The connect command is intended to open a WebSocket connection to an endpoint.
cortlet-ws connect wss://example.com/socket
Planned behavior includes displaying connection status and incoming messages.
Send
The send command is intended to send data to a WebSocket endpoint.
cortlet-ws send wss://example.com/socket "hello"
Message input formats and command options are still being finalized.
Ping
The ping command is intended to test whether a WebSocket endpoint is reachable and responsive.
cortlet-ws ping wss://example.com/socket
Final timing and output behavior may change.
Inspect
The inspect command is intended to display information about a WebSocket connection.
cortlet-ws inspect wss://example.com/socket
The exact inspection fields are not stable yet.
Reconnect testing
The reconnect-test command is intended to help test how a WebSocket endpoint behaves when a connection is interrupted and re-established.
cortlet-ws reconnect-test wss://example.com/socket
Reconnect behavior and configuration options are still in development.
Installation
Installation instructions are not published yet.
The final documentation will include supported platforms, release downloads, installation steps, and update instructions once the first public release is ready.
Platform support
Initial development is focused on macOS.
Additional platform support may be documented later depending on the release build and distribution format.
Planned documentation
More documentation will be published as the CLI approaches release.
Planned areas include:
- Installation
- Getting started
- Connect
- Send
- Ping
- Inspect
- Reconnect testing
- Command reference
- Output reference
- Errors
- Troubleshooting
- Updating the CLI
Relationship to Cortlet Gateway
Cortlet WebSocket CLI and Cortlet Gateway are separate products.
The CLI is a developer tool for interacting directly with WebSocket endpoints.
Cortlet Gateway is intended to provide hosted infrastructure for bridging persistent WebSocket connections to HTTP backends.
The CLI does not require Cortlet Gateway in order to be useful.
View Cortlet Gateway documentation
Availability
Cortlet WebSocket CLI is currently in development.
Stable installation and command documentation will be published with the first public release.
For general Cortlet information, visit cortlet.com.