https://github.com/scum-forge/sctl
CLI/API tools to help you manage a dedicated server
https://github.com/scum-forge/sctl
admin administration api cli database scum sqlite
Last synced: about 2 months ago
JSON representation
CLI/API tools to help you manage a dedicated server
- Host: GitHub
- URL: https://github.com/scum-forge/sctl
- Owner: scum-forge
- License: mit
- Created: 2025-07-10T19:55:47.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-07-14T06:40:00.000Z (12 months ago)
- Last Synced: 2025-07-14T09:37:28.404Z (12 months ago)
- Topics: admin, administration, api, cli, database, scum, sqlite
- Language: TypeScript
- Homepage:
- Size: 126 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sctl
A CLI/API exposing the SCUM database in a human friendly way.
## ✨ Why use this?
- 👉 **Human friendly** — designed for humans (easy access to server resources)
- 🚀 **Exposed API** — integrate with your existing tool (e.g. a bot, web interface, etc.)
- 🤝 **Compatibility** — designed with Node.js and Bun support in mind
- 🔍 **Access to hard-to-reach data** — makes it simple to query and interact with parts of the database that are complex to retrieve
- 🛠️ **Extra resources** — includes several non-database useful features like in-game time config calculations and other gameplay-related settings
## 🚀 Usage guide
> [!TIP]
> Please verify the current usage (and all the available commands) using:
> ```shell
> sctl --help
> sctl get --help
> sctl get body-simulation --help
> # ...
> ```
- Get information about the owner of a vehicle:
```shell
sctl get vehicle-owner
```
- Retrieve parsed readable prisoner's body simulation:
```shell
sctl get body-simulation
```
## 📝 Changelog
Read the [commits](../../commits) for a comprehensive list of changes.
## 📜 License
Licensed under [MIT License](LICENSE).