The af command is the Airfold CLI, it accepts a variety of commands such as af push or af source.
To view a list of the commands available in your current Airfold version, simply run af with no additional arguments:
To get detailed information on a specific command, use the --help option.
For instance, learn more about the pipe command by running:
The Airfold CLI provides interactive, detailed output to enhance your command-line experience.
When output is redirected, it automatically switches to JSON format when possible to support seamless data handling and parsing.
Commands
Configure your environment, such as credentials.
Diff between local and remote objects.
Check your system for potential problems.
Fix issues automatically.
Format local object files.
Show execution plan without executing it.
Overwrite existing local file(s) without confirmation.
Generate events.
Generate events based on a template or file.
Event template name or path to file.
Source to send events to.
Limit amount of events. Default: -1
Send events per second. Default: 1
Dump graph of runtime objects in JSON format to file or stdout.
Pipe commands.
Delete pipe.
Force delete/overwrite even if data will be lost.
Show execution plan without executing it.
Materialize draft pipe.
Target directory to create files in, (’-’ will dump to stdout). Default: ’-’ (stdout).
Query pipe data.
Output data format. Options: json, ndjson. Default: ndjson.
Set pipe parameters in the form of name=value. Can be repeated.
Pull objects from the runtime database.
Target directory to create files in, (’-’ will dump to stdout). Default: ’-’ (stdout).
Push object(s) into the runtime database.
Target directory to read files from, (’-’ will read from stdin). Default: None
Show execution plan without executing it.
Force delete/overwrite even if data will be lost.
Use rename strategy. Specify a single renamed object name and its new name.
Source commands.
Create source.
Path to a local object file(s) or URL.
Target directory to create files in, (’-’ will dump to stdout). Default: ’-’ (stdout). Preserves workspace structure.
New source output path, ex.: sources/src1.yaml. It overrides path argument. Default: None.
Append data to source.
Path to a local file(s) or URL(s).
Delete source data.
SQL WHERE condition to delete data. Ex.: logLevel=‘ERROR’
Delete source.
Show execution plan without executing it.
Force delete/overwrite even if data will be lost.
Truncate source (delete all data).
Recalculate AI columns.
Columns to recalculate. Default: None.
Wait for recalculation to finish. Default: False.
Maximum time to wait for recalculation to finish. Default: 900 seconds.
Source commands.
Cancel job.
Wait for job to be canceled. Default: False.
Set verbosity level, can be repeated.
