AtmosphericX - Command Reference (GUIDE)
AtmosphericX Command Reference Guide
This guide provides a comprehensive reference for the commands available in the AtmosphericX platform. Each command is designed to perform specific actions related to account management, debugging, and system maintenance.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
Memory: 27 MiB (7%)
┌─────────┬─────────────────────┬──────────────────────────────┬─────────────────────────────────────────────────────┐
│ (index) │ Command │ Description │ Usage │
├─────────┼─────────────────────┼──────────────────────────────┼─────────────────────────────────────────────────────┤
│ 0 │ '/help' │ 'List all commands' │ 'No usage' │
│ 1 │ '/activate-account' │ 'Activates an account (0/1)' │ '<username> <1 = Activate | 0 = Deactivate>' │
│ 2 │ '/account-role' │ "Sets a user's role (0/1)" │ '<username> <0 = Default User | 1 = Administrator>' │
│ 3 │ '/delete-account' │ 'Deletes an account' │ '<username>' │
│ 4 │ '/force-update' │ 'Force update all clients' │ 'No usage' │
│ 5 │ '/clients' │ 'Get all clients' │ 'No usage' │
│ 6 │ '/debug-xml' │ 'Debug XML alerts' │ 'No usage' │
│ 7 │ '/debug-raw' │ 'Debug raw alerts' │ 'No usage' │
│ 8 │ '/debug-ugc' │ 'Debug ugc codes' │ 'No usage' │
│ 9 │ '/clear' │ 'Clear console' │ 'No usage' │
│ 10 │ '/memory-dump' │ 'Create a memory dump' │ 'No usage' │
│ 11 │ '/hammer-time' │ 'Stress testing' │ 'No usage' │
└─────────┴─────────────────────┴──────────────────────────────┴─────────────────────────────────────────────────────┘
Actual display may vary based on the terminal or console used.
Types of Commands
- /help: Lists all available commands and their descriptions in a clean table format.
- /activate-account: Activates or deactivates a user account. Usage:
<username> <1 = Activate | 0 = Deactivate>. - /account-role: Sets a user’s role to either default user or administrator. Usage:
<username> <0 = Default User | 1 = Administrator>. - /delete-account: Deletes a user account. Usage:
<username>. - /force-update: Forces an update for all clients connected to the system.
- /clients: Retrieves a list of all clients currently connected to the dashboard including their status and details.
- /debug-xml: Debugs XML (CAP) alerts, providing detailed information about the XML structure and content. (NWWS-OI)
- /debug-raw: Debugs raw text alerts. (NWWS-OI)
- /debug-ugc: Debugs UGC (Universal Geographic Code) identifiers, providing detailed information about the UGC structure and content.
- /clear: Clears the console output, providing a clean slate for new commands and outputs.
- /memory-dump: Creates a memory dump of the current system state, useful for debugging and analysis.
- /hammer-time: Initiates stress testing on the system, simulating high load conditions to test performance and stability. (REQUIRES NWWS-OI)
Managing Accounts
Managing user accounts is a crucial aspect of the project as it not only allows you to control who has access to your instance, and is critical for the security of your instance. We will go over some critical commands that you will need to know in order to properly manage your account database.
Activating and Deactivating Accounts
Every account besides the default root account is deactivated by default. This means that you will need to activate the account before it can be used in your instance. Why? This helps prevent unauthorized access to your instance and ensures that only accounts you have created can be used. Additionally, you can deactivate accounts to prevent them from being used without deleting them. This is useful for temporarily disabling accounts without losing their data.
To activate or deactivate a user account, use the /activate-account command. This command requires the username and a flag indicating whether to activate (1) or deactivate (0) the account.
1
2
/activate-account username 1 # Activates the account
/activate-account username 0 # Deactivates the account
Setting User Roles
User roles play a significant role in managing permissions and access levels within the AtmosphericX platform. There are currently two roles available, default user and administrator. The default user role has limited access to the project with little to no management capabilities but still provides access to the dashboard and its features. The administrator role has full access to the project including the configurations, widget manager, and the entire administration panel. (SOON).
To set a user’s role, use the /account-role command. This command requires the username and a flag indicating whether to set the role to default user (0) or administrator (1).
1
2
/account-role username 0 # Sets the user role to default user
/account-role username 1 # Sets the user role to administrator