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, run af
with no additional arguments.
To get specific help for any command, use the --help
option with the relevant command.
For example, to see help about the pipe
command you can run af pipe --help
.
Our CLI is designed to provide a rich, interactive output.
However, when you’re redirecting the output, we switch to the JSON format wherever it’s possible for easier data parsing and handling.
Here’s a brief overview of all the available commands, arguments, and flags:
Properties
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.