Aralez Docs
v0.11.0 Download
Core concepts/CLI reference
Command line

Control the run without changing the profile.

CLI options override selected archive and output behavior or perform executable-management operations that exit before collection.

Syntax

Windows first · then Linux/macOS
aralez.exe [OPTIONS]
aralez [OPTIONS]

Help and version

-h, --help
Print command help

Shows the options compiled for the current operating system and exits.

exit
-V, --version
Print binary version

Reports the Cargo package version compiled into the executable and exits.

exit

Collection options

-v, --verbos
Verbose/debug logging

Sets DEBUG_MODE=true. The long flag is spelled --verbos in v0.11.0.

flag
--silent
Suppress terminal output

Uses a hidden progress bar; run logs are still written into the archive.

flag
--stream
Stream into the archive

Avoids creating a complete intermediate collection folder.

flag
--compression <TYPE>
Choose archive engine

Accepted values are zip and tar. TAR output uses the .tar.zst extension.

zip
-e, --encrypt <PASSWORD>
Encrypt ZIP entries

Overrides profile-level encrypt and enables AES-256 encryption on ZIP output.

value
-w, --workdir <PATH>
Set working directory

Creates the directory if needed, then changes into it before output naming and collection.

path
-d, --default_drive <DRIVE>
Select drive/device

Defaults to C on Windows. Optional on Unix targets, which discover the root device.

platform

Output options

-o, --output <DESTINATION>
Override configured destinations

Accepts s3://, sftp://, smb://, or a local/mounted folder path.

URI
--s3-endpoint <URL>
Custom S3 endpoint

Used for MinIO and other S3-compatible services; forces path-style requests.

URL
--s3-access-key <KEY>
Explicit S3 access key

Takes precedence over credentials embedded in a configured S3 destination.

secret
--s3-secret-key <SECRET>
Explicit S3 secret key

Supply with the access key; prefer a short-lived environment or managed role where possible.

secret

Configuration management

-s, --show_config
Print embedded YAML

Writes the raw embedded configuration to stdout and exits.

exit
-x, --check_config
Validate current embedded YAML

Parses the loaded configuration, prints confirmation, and exits.

exit
-c, --change_config <CONFIG_FILE> <OUTPUT_FILE>
Create a re-profiled binary

Validates a YAML file and embeds it into a copy of the current executable.

2 values

CLI precedence and early-exit behavior

InputRuntime rule
--streamLogical OR with YAML stream. It can enable streaming but cannot disable stream: true.
--compressionReplaces YAML compression for the run.
--encryptReplaces the global YAML archive password. It does not change entry-level file encryption settings.
--outputUses exactly one CLI destination and skips the entire YAML destination list.
S3 CLI overrides--s3-endpoint, access key, and secret key take precedence over the selected S3 destination’s YAML values.
--workdirCreates and enters the directory before output naming, log creation, archive creation, and relative destination resolution.
Management commands--show_config, --check_config, --change_config, and Windows tool-resource operations exit before resource checks or collection.
!
Secrets on the command line

Archive passwords and explicit S3 keys supplied as arguments may be exposed through process inventory, shell history, remote-execution logs, and endpoint telemetry. Prefer scoped workload credentials or controlled environment injection where possible.

Windows-only executable resources

-l, --list_tools
List embedded external tools

Distinguishes statically compiled tools from dynamically added executable resources.

Windows
-a, --add_tool <EXE> <OUTPUT_EXE>
Add an executable resource

Creates a new Aralez executable with the supplied tool embedded.

Windows
-r, --remove_tool <NAME> <OUTPUT_EXE>
Remove a dynamic resource

Creates a new executable without the named dynamic tool. Static tools cannot be removed this way.

Windows

Command builder

Generated command
aralez.exe --stream --compression zip
NextConfiguration→