ato-cli

ato-cli

---

allThingsOps CLI to help DevOps -> MLOps -> DataOps

📝 Table of Contents

- About
- Getting Started
- Deployment
- Usage
- Built Using
- TODO
- Contributing
- Authors
- Acknowledgments

🧐 About

allThingsOps CLI for use with everything Ops and everything FiveM.

🏁 Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

API for getting FiveM server info & status.

Installation

``
npm i ato-cli -g
`

`
ALL FUNCTION REQUESTS
- getPlayers - Number of players online - (number)
- getPlayersAll - List all players in an array - (string)
- getMaxPlayers - Max players that are able to join the server - (number)
- getResources - Get resource names of all server resources - (string/array)
- getTags - Get all server tags - (string)
- getServer - Get the whole server object - (string)
- getOnesync - See if the server has OneSync enabled - (boolean)
- getLocale - The language of the server - (string)
- getGamename - Get the name of the server - (string)
- getEnhancedHostSupport - ... - (boolean)
- getlicenseKeyToken - The license key for the server - (string)
- getScriptHookAllowed - See if the server supports external mod menus from the client - (boolean)
`

🔧 Running the tests

`
ato test
`

$3

Test the API status

`
ato api test
`

$3

How to login

`
ato login
`

🎈 Usage

See if server is online (json)
`js
const FiveM = require("fivem") // Import the npm package.
const srv = new FiveM.Server('IP:PORT') // Set the IP with port.

srv.getServerStatus().then(data => console.log(data)) // Get & log the data!

//if online returns json {online: true}
// if offline returns json {online: false, url: x, method: x}
`

Get Player Count (in numbers)
`js
const FiveM = require("fivem") // Import the npm package.
const srv = new FiveM.Server('IP:PORT') // Set the IP with port.

srv.getPlayers().then(data => console.log(data)) // Get & log the data!
`

Get all Resources
`js
const FiveM = require("fivem") // Import the npm package.
const srv = new FiveM.Server('IP:PORT') // Set the IP with port.

srv.getResources().then(data => console.log(data)) // Get & log the data!
`

🚀 Deployment

`
npm i -g
``

⛏️ Built Using

- Yarn - Build Tool
- NodeJs - Server Environment
- VSCode - Coding IDE

✍️ Authors

- @wittyphantom333 - Idea & Initial work

See also the list of contributors who participated in this project.

🎉 Acknowledgements

- Thank you to @JackCrispy for the API part of this project