Command Palette

Search for a command to run...

Console commands

Every AstroShield command you can run in the server console.

AstroShield registers a few commands for you, the server owner. They can only be run from the server console (the txAdmin live console, your host's panel or the terminal the server runs in), not from in-game chat or F8. If somebody tries from in game, nothing happens for them and the server console prints This command can only be used from the server console.

astroshield#

Run astroshield with no argument to list the commands. The sub-commands are:

CommandWhat it does
astroshield statusShows the connection, license and module state.
astroshield playersLists the players that are online with their ID, ping, whether AstroShield is ready for them and whether they count as admin.
astroshield clear [objects|peds|vehicles|all]Deletes all entities of that type from the world and says how many.
astroshield unban <banId>Removes a ban. Use the ban ID from the ban screen or the dashboard, or a case ID.
astroshield case [caseId]Lists the recent ban cases this server remembers, or one case.
astroshield installAdds the shared guard to all resources. Same as astroinstall.
astroshield uninstallRemoves it again. Same as astrouninstall.

astroshield status#

Example output (your values will differ):

Output
[AstroShield] Status:
  Server: My Roleplay Server
  Version: 1.0.0
  Dashboard: Online
  License: active (2026-12-01)
  Config: loaded
  Dev mode: off
  Modules: 71 active / 94 configured
  Event guard: enabled
LineMeaning
DashboardOnline when the resource is connected to the backend, Offline when it is not.
LicenseThe license status and the expiry.
Configloaded, or waiting for dashboard while your configuration has not arrived.
Dev modeWhether Dev Mode is on.
ModulesDetections switched on out of all configured ones.
Event guardWhether the event protection is enabled.

When you ask for help, paste this output.

astroinstall and astrouninstall#

astroinstall adds the line shared_script '@AstroShield/shared-obfuscated.lua' to the manifest of every other resource. It runs by itself on every start, so you rarely need it. Run it by hand after you added resources, or after something overwrote your manifests.

astrouninstall removes that line again. Use it before you remove AstroShield.

Both print one line per resource and a summary. They need the permissions from the installation.

  • restart AstroShield restarts the resource. Do it after an update and after a refused license is fixed, for example an approved IP reset.
  • stop AstroShield and start AstroShield pause and resume the protection.

Permissions#

These commands are restricted. In the real server console they just work. If you run them through a console that checks ACE permissions, such as the txAdmin live console with a limited admin, the user needs command.astroshield, command.astroinstall and command.astrouninstall.