https://github.com/leonardodino/rcon-shell

:pager: minimal rcon shell for classic hlds
https://github.com/leonardodino/rcon-shell

hlds rcon shell

Last synced: 2 months ago
JSON representation

:pager: minimal rcon shell for classic hlds

• Host: GitHub
• URL: https://github.com/leonardodino/rcon-shell
• Owner: leonardodino
• License: mit
• Created: 2020-05-17T14:11:18.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2020-08-23T05:32:02.000Z (over 4 years ago)
• Last Synced: 2024-12-06T21:51:17.503Z (3 months ago)
• Topics: hlds, rcon, shell
• Language: TypeScript
• Homepage:
• Size: 135 KB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# rcon-shell

[](https://github.com/leonardodino/rcon-shell)

[**`rcon`**](https://developer.valvesoftware.com/wiki/Half-Life_Dedicated_Server#Connectivity) interactive shell via `µdp`

## features

:brain: **autocompletion**


  for commands, maps and `cvar`s




:clamp: **lightweight** + **minimalist**


  single self-contained file, under `5kb`


  no 3rd party dependencies




:moyai: **compatible**


  supports node `v10+`


  can be saved directly to `PATH`

## installation

  curl

  

    curl -sL https://unpkg.com/rcon-shell/bin/rcon-shell > /usr/local/bin/rcon-shell

    


    chmod +x /usr/local/bin/rcon-shell

  

  yarn

  yarn global add rcon-shell



  npm

  npm i -g rcon-shell



  npx

  npx rcon-shell

## usage

```bash

RCON_HOST=example.org RCON_PASSWORD=your-password-here rcon-shell

```

the cli does not receive arguments.

it is configured via 3 environment variables:

| name            | default     | description                           |

| :-------------- | :---------- | :------------------------------------ |

| `RCON_PASSWORD` | (required)  | `rcon` admin password                 |

| `RCON_HOST`     | `127.0.0.1` | server to connect to (IP or DNS host) |

| `RCON_PORT`     | `27015`     | `udp` port to use for communication   |

**to exit**: ctrl + C or type `exit`

## system requirements

| [`node`](https://nodejs.org/en/) | [`hlds`](https://developer.valvesoftware.com/wiki/Half-Life_Dedicated_Server) (or other `rcon`-compatible udp server) |

| :------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------ |

| any LTS version after v10        | configured with `rcon_password`                                                                                                             |

## license

[`MIT`](./LICENSE)