{"id":13674439,"url":"https://github.com/gorcon/rcon-cli","last_synced_at":"2025-04-28T14:31:25.737Z","repository":{"id":37236474,"uuid":"198286115","full_name":"gorcon/rcon-cli","owner":"gorcon","description":"RCON client for executing queries on game server.","archived":false,"fork":false,"pushed_at":"2024-02-11T14:21:59.000Z","size":146,"stargazers_count":376,"open_issues_count":14,"forks_count":41,"subscribers_count":14,"default_branch":"master","last_synced_at":"2024-02-11T15:29:40.317Z","etag":null,"topics":["ark-survival-evolved","conan-exiles","csgo","minecraft","project-zomboid","projectzomboid","rcon","rcon-cli","rcon-protocol","steam","zomboid"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gorcon.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2019-07-22T19:05:54.000Z","updated_at":"2024-04-15T15:47:18.191Z","dependencies_parsed_at":"2023-11-22T07:25:13.339Z","dependency_job_id":"6d3a9663-fc36-4c21-9f5c-47f02037f869","html_url":"https://github.com/gorcon/rcon-cli","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gorcon%2Frcon-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gorcon%2Frcon-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gorcon%2Frcon-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gorcon%2Frcon-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gorcon","download_url":"https://codeload.github.com/gorcon/rcon-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224120186,"owners_count":17259026,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ark-survival-evolved","conan-exiles","csgo","minecraft","project-zomboid","projectzomboid","rcon","rcon-cli","rcon-protocol","steam","zomboid"],"created_at":"2024-08-02T11:00:50.438Z","updated_at":"2024-11-11T14:31:02.257Z","avatar_url":"https://github.com/gorcon.png","language":"Go","funding_links":[],"categories":["Software","Games"],"sub_categories":["Games - Administrative Utilities \u0026 Control Panels","E-commerce"],"readme":"# rcon-cli\n[![Mentioned in Awesome-Selfhosted](https://awesome.re/mentioned-badge.svg)](https://github.com/awesome-selfhosted/awesome-selfhosted)\n[![GitHub Build](https://github.com/gorcon/rcon-cli/workflows/build/badge.svg)](https://github.com/gorcon/rcon-cli/actions)\n[![Go Coverage](https://github.com/gorcon/rcon-cli/wiki/coverage.svg)](https://raw.githack.com/wiki/gorcon/rcon-cli/coverage.html)\n[![Go Report Card](https://goreportcard.com/badge/github.com/gorcon/rcon-cli)](https://goreportcard.com/report/github.com/gorcon/rcon-cli)\n[![GitHub All Releases](https://img.shields.io/github/downloads/gorcon/rcon-cli/total)](https://github.com/gorcon/rcon-cli/releases)\n[![Docker Pulls](https://img.shields.io/docker/pulls/outdead/rcon.svg)](https://hub.docker.com/r/outdead/rcon)\n\nCLI for executing queries on a remote [Source dedicated game server](https://developer.valvesoftware.com/wiki/Source_Dedicated_Server), using the [RCON](https://developer.valvesoftware.com/wiki/Source_RCON_Protocol) protocol.\n\n## Supported Games\n* [7 Days to Die](https://store.steampowered.com/app/251570) (add `-t telnet` to rcon-cli args)\n* [ARK: Survival Evolved](https://store.steampowered.com/app/346110)\n* [Avorion](https://store.steampowered.com/app/445220/Avorion/)\n* [Conan Exiles](https://store.steampowered.com/app/440900)\n* [Counter-Strike: Global Offensive](https://store.steampowered.com/app/730)\n* [Factorio](https://factorio.com/)\n* [Minecraft](https://www.minecraft.net)\n* [Project Zomboid](https://store.steampowered.com/app/108600) \n* [Rust](https://store.steampowered.com/app/252490) (add `+rcon.web 0` to the args when starting the server or add `-t web` to `rcon-cli` args)\n* [Team Fortress 2](https://store.steampowered.com/app/440/Team_Fortress_2/)\n* [V Rising](https://store.steampowered.com/app/1604030/V_Rising/)\n* [Palworld](https://store.steampowered.com/app/1623730/Palworld/)\n\n\n\n\nOpen pull request if you have successfully used a package with another game with rcon support and add it to the list.\n\n## Installation\nDownload the binary for your platform from the [latest releases](https://github.com/gorcon/rcon-cli/releases/latest)\n\nSee [Changelog](CHANGELOG.md) for release details\n\n### Docker\n```bash\ndocker pull outdead/rcon\n```\n\n## Usage\n```text\nUSAGE:\n   rcon [options] [commands...]\n\nGLOBAL OPTIONS:\n   --address value, -a value   Set host and port to remote server. Example 127.0.0.1:16260\n   --password value, -p value  Set password to remote server\n   --type value, -t value      Specify type of connection (default: rcon)\n   --log value, -l value       Path to the log file. If not specified it is taken from the config\n   --config value, -c value    Path to the configuration file (default: rcon.yaml)\n   --env value, -e value       Config environment with server credentials (default: default)\n   --skip, -s                  Skip errors and run next command (default: false)\n   --timeout value, -T value   Set dial and execute timeout (default: 10s)\n   --help, -h                  show help (default: false)\n   --version, -v               print the version (default: false)\n```\n\nRcon CLI can be run in two modes - in the mode of a single query and in the mode of reading the input stream\n\n### Single mode\nServer address, password and command to server must be specified in flags at startup. Example:  \n```bash\n./rcon -a 127.0.0.1:16260 -p mypassword command\n```\n\nIt is possible to send several commands in one request. Example:  \n```bash\n./rcon -a 127.0.0.1:16260 -p mypassword command \"command with several words\" 'command \"with double quotes\"'\n```\n\nIf commands passed, they sent in a single mode. The response displayed, and the CLI will exit.\n\n### Interactive input stream mode\nTo run CLI in interactive mode run `rcon` without commands. Example:\n```bash\n./rcon -a 127.0.0.1:16260 -p mypassword\n```\n\nUse `^C` to terminate or type command `:q` to exit.    \n\n### In Docker\n```bash\ndocker run -it --rm outdead/rcon ./rcon [options] [commands...]\n```\n\nYou can add your config file as volume:\n```bash\ndocker run -it --rm \\\n      -v /path/to/rcon-local.yaml:/rcon.yaml \\\n      outdead/rcon ./rcon -c rcon.yaml -e default players\n```\n\n## Configuration file\nFor more convenient use, the ability to create the `rcon.yaml` configuration file provided. You can save the host and port of the remote server and its password. If the configuration file exists, and the default block filled in it, then at startup the `-a` and `-p` flags can be omitted. Examples:\n```bash\n./rcon -a 127.0.0.1:16260 players\n./rcon status\n./rcon -p mypassword\n./rcon\n```\n\nDefault configuration file name is `rcon.yaml`. File must be saved in yaml format. It is also possible to set the environment name and connection parameters for each server. You can enable logging requests and responses. To do this, you need to define the log variable in the environment blocks. You can do \nthis for each server separately and create different log files for them. If the path to the log file not specified, then logging will not be conducted. \n```yaml\ndefault:\n  address: \"127.0.0.1:16260\"\n  password: \"password\"\n  log: \"rcon-default.log\"\nzomboid:\n  address: \"127.0.0.1:16260\"\n  password: \"password\"\n  log: \"rcon-zomboid.log\"\nrust:\n  address: \"127.0.0.1:28003\"\n  password: \"password\"\n7dtd:\n  address: \"172.19.0.2:8081\"\n  password: \"password\"\n  type: \"telnet\"\n```\n\n## Args\nYou can choose the environment at the start:\n```bash\n./rcon -e rust status\n./rcon -e zomboid\n```\n\nSet custom config file:\n```bash\n./rcon -c /path/to/config/file.yaml\n```\n\nUse `-l` argument to specify path to log file:\n```bash\n./rcon -l /path/to/file.log\n```\n\nUse `-t` argument to specify the protocol type:\n```bash\n# 7 Days to Die\n./rcon -a 172.19.0.2:8081 -p password -t telnet version\n\n# Rust\n./rcon -a 127.0.0.1:28016 -p password -t web status\n```\n\nUse `-T` argument to specify dial and execute timeout:\n```bash\n./rcon -a 172.19.0.2:8081 -p password -t telnet -T 10s version\n```\n\n## Contribute\nIf you think that you have found a bug, create an issue and indicate your operating system, platform, and the game on which the error reproduced. Also describe what you were doing so that the error could be reproduced.\n\n## License\nMIT License, see [LICENSE](LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgorcon%2Frcon-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgorcon%2Frcon-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgorcon%2Frcon-cli/lists"}