Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
- [Using Environment Variable for Password](#using-environment-variable-for-password)
- [Configuration Profiles](#configuration-profiles)
- [CLI Flags](#cli-flags)
- [Interactive UX](#interactive-ux)
- [Protocol Compliance](#protocol-compliance)
- [Using as a Library](#using-as-a-library)
- [Streaming Responses](#streaming-responses)
Expand Down Expand Up @@ -159,6 +160,20 @@ tcprcon-cli --profile="my_server" --port=27015
saves current connection parameters as a profile. Value is the profile name.
```

## Interactive UX

The interactive terminal UI supports the following keyboard controls:

| Key | Action |
|-----|--------|
| `Enter` | Submit command |
| `Backspace` | Delete last character |
| `↑` / `↓` | Navigate command history |
| `Page Up` | Scroll output up one page |
| `Page Down` | Scroll output down one page |

When scrolled up, a `[↑ N]` indicator is shown in the prompt line, where `N` is the number of lines scrolled above the bottom. Submitting a command snaps the view back to the bottom.

## Protocol Compliance

While `tcprcon-cli` follows the standard Source RCON Protocol, some game servers (like Rust) have non-standard implementations that might introduce unexpected behaviors, such as duplicated responses or incorrect packet IDs, the cli should still work, you might just have to deal with an overly chatty server.
Expand Down
Loading