Documentation Index
Fetch the complete documentation index at: https://docs.getgaal.com/llms.txt
Use this file to discover all available pages before exploring further.
Every gaal invocation starts with gaal. Global flags can sit before or after the subcommand.
Global flags
These work with every command:
| Flag | Default | Description |
|---|
-c, --config <path> | gaal.yaml | Path to the configuration file. |
-v, --verbose | off | Enable debug logging. |
--no-banner | off | Suppress the ASCII-art banner. |
--sandbox <dir> | unset | Redirect every write to this directory. See Sandbox mode. |
--log-file <path> | unset | Write structured JSON logs to this file (in addition to console). |
-o, --output <fmt> | text | Output format: text, table, or json. text is the default human- and pipe-friendly layout; table renders boxed pterm tables; json emits structured data and suppresses the banner automatically. |
Commands
| Command | Purpose |
|---|
gaal sync | Reconcile every resource in gaal.yaml against the filesystem. |
gaal status | Print the current state of every repo, skill, and MCP entry. |
gaal agents | List registered coding agents and detection status. |
gaal info | Detailed view of a single repo, skill, MCP, or agent. |
gaal init | Bootstrap a gaal.yaml interactively or from flags. |
gaal audit | Read-only scan of skills and MCP entries already on the machine. |
gaal doctor | Health check on configuration, sources, targets, and agents. |
gaal migrate | Validate and prepare configuration for Community Edition. |
gaal schema | Print or write the JSON Schema for gaal.yaml. |
gaal version | Print version and build time. |
gaal completion | Generate shell completion scripts. |
Exit codes
Most commands follow this convention:
| Code | Meaning |
|---|
0 | Success, nothing to do, or work completed cleanly. |
1 | Warning, work completed but with non-fatal issues, or --dry-run reports pending changes. |
2 | Error, operation failed. |
Examples
# Use a config in /etc rather than the default
gaal --config /etc/gaal/team.yaml sync
# Verbose JSON output
gaal --verbose -o json status
# Sync everything into a sandbox
gaal --sandbox /tmp/gaal-test sync
# Service mode with logging
gaal --log-file /var/log/gaal.json sync --service --interval 5m
