Common Commands

By default, ARES commands start with @ when typed in local chat.

However, @ is not used when writing shell scripts. An @ in an ARES shell script indicates a label (jump destination).

This is a small subset of the most commonly requested/utilized commands when operating ARES. A full listing of all commands, their options, and flags, can be found in the Command Reference Guide.

Common Command Types

Basic Commands

Power on: @on
Power off: @off
Powercycle off/on: @reboot
Restart all ARES modules: =ddt reset
Run the Setup wizard: @setup

ID metadata commands

Setting your name: @name <value>
Setting your designation prefix: @db set id.prefix <value>
Clearing your designation prefix: @db set id.prefix
Applying the above settings: @id regen

Setting a custom serial number: @db set id.serial <value>

Note: Running @id regen will regenerate your default serial number, clearing any custom one you may have applied.

Setting your model: @db set id.model <value>
Setting your authority: @db set id.authority <value>
Setting your vendor: @db set id.vendor <value>

Color commands

Change a color slot: @color <slot> <value>

<slot> can be a, b, c, d,or all. Color values can be either a predefined swatch name or a value in RGB (R G B, 0-255), LSL (R G B, 0-1), or Hex (#000000 to #ffffff) format.

See current color info, available swatches, and available schemes: @color
Save a color scheme: @color save <name>
Load a color scheme: @color load <name>
Save a new color swatch: @color swatch <value>

Color A is your primary system color. This will show on your controller and most accessories.
Color B is your "positive indicator" color. This will show on some accessories and some HUD elements, as well as your menu text.
Color C is your "negative indicator" color. This will show on some accessories and some HUD elements, as well as most holomenu backgrounds.
Color D is your general HUD color. Most HUD elements will be colored this color, and some accessories may display this channel.

Persona commands

See a list of available personas: @persona
Load a persona: @persona <name>

Vox/speech commands

Clear a backlogged vox pipe: @input purge
Enable the input or output vox pipe: @vox input|output on
Disable the input or output vox pipe: @vox input|output off
Enable a vox filter: @vox <pipe> <filter> add
Configure a vox filter: @vox <pipe> <filter> <flags>

More information about what preset vox filters are available and their configuration flags can be found here

Software/Update commands

Note that most of these commands will require you to be in Eisa or in another region with an available package server. System upgrades will only be available in Eisa.

Identify available software: @software update
List available software: @software available
List installed software: @software list
Update currently installed software: @software upgrade

Direct comparison with common shells

Linux bash	Windows cmd.exe	ARES exec	ARES default aliases
cat <file>	type <file>	type <file>
ls <pattern>	dir <pattern>	fs match <pattern>	ls <pattern>
ls	dir	fs
shutdown -h now	shutdown /s /t 0	power system off	off
echo <string>	echo <string>	echo <string>
<var>=<string>	set <var>=<string>	set <var> <string>
rm <file>	del <file>	fs remove <file>
env	set	db env	env
exit	goto :EOF	exit
—	goto <label>	jump <label>
—	:<label>	@<label>:

File existence checks
bash	if -e <file>; then <command>; fi
cmd.exe	if exist <file> <command>
exec	if exist <file> then <command>

String comparison
bash	if [ <string1>==<string2> ]; then <command>; fi
cmd.exe	if <string1>==<string2> <command>
exec	if <string1> is <string2> then <command>

Storing a numeric expression in an environment variable
bash	let <var>=<math>
cmd.exe	set /a <var>=<math>
exec	set <var>=<math>

Notes:

The bourne shell is an ALGOL dialect; for ideological reasons it does not support goto
The 'fs match <pattern>' facility in ARES is designed for creating file associations, not data science; it only supports a single "*" wildcard

return to Charts