CLI Reference

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:

af

To get detailed information on a specific command, use the --help option.

For instance, learn more about the pipe command by running:

af pipe --help

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

config

Command

Configure your environment, such as credentials.

diff

Command

Diff between local and remote objects.

doctor

Command

Check your system for potential problems.

Show Flags

--fix

Flag

Fix issues automatically.

--list-checks

Flag

List available checks.

fmt

Command

Format local object files.

Show Flags

--dry-run

Flag

Show execution plan without executing it.

--overwrite

Flag

Overwrite existing local file(s) without confirmation.

generate

Command

Generate events.

Show Subcommands

events

Subcommand

Generate events based on a template or file.

Show Arguments and Flags

temp_name

Argument

required

Event template name or path to file.

--send

Flag

Source to send events to.

--limit

Flag

Limit amount of events. Default: -1

--eps

Flag

Send events per second. Default: 1

Subscribe to events.

Show Arguments and Flags

templ_name

Argument

required

Demo template name.

unsubscribe

Subcommand

Unsubscribe from events.

graph

Command

Dump graph of runtime objects in JSON format to file or stdout.

pipe

Command

Pipe commands.

Show Subcommands

delete

Subcommand

Delete pipe.

Show Arguments and Flags

name

Argument

required

Pipe name.

--force

Flag

Force delete/overwrite even if data will be lost.

--dry-run

Flag

Show execution plan without executing it.

Subcommand

List pipes.

materialize

Subcommand

Materialize draft pipe.

Show Arguments and Flags

name

Argument

required

Pipe name.

path

Argument

Target directory to create files in, (’-’ will dump to stdout). Default: ’-’ (stdout).

query

Subcommand

Query pipe data.

Show Arguments and Flags

name

Argument

required

Pipe name.

--format

Flag

Output data format. Options: json, ndjson. Default: ndjson.

--param

Flag

Set pipe parameters in the form of name=value. Can be repeated.

run

Subcommand

Run pipe and get data.

Show Arguments and Flags

name

Argument

required

Pipe name.

path

Argument

Path to a local object file(s), (’-’ will read objects from stdin). By default will look for a pushed pipe.

--format

Flag

Output data format. Options: json, ndjson. Default: ndjson.

--param

Flag

Set pipe parameters in the form of name=value. Can be repeated.

--node

Flag

Node name. Run only this node. By default, all nodes are run.

pull

Command

Pull objects from the runtime database.

Show Arguments

path

Argument

Target directory to create files in, (’-’ will dump to stdout). Default: ’-’ (stdout).

push

Command

Push object(s) into the runtime database.

Show Arguments and Flags

path

Argument

Target directory to read files from, (’-’ will read from stdin). Default: None

--dry-run

Flag

Show execution plan without executing it.

--force

Flag

Force delete/overwrite even if data will be lost.

--rename

Flag

Use rename strategy. Specify a single renamed object name and its new name.

source

Command

Source commands.

Show Subcommands

Subcommand

List sources.

create

Subcommand

Create source.

Show Arguments and Flags

events_path

Argument

required

Path to a local object file(s) or URL.

path

Argument

Target directory to create files in, (’-’ will dump to stdout). Default: ’-’ (stdout). Preserves workspace structure.

--out

Flag

New source output path, ex.: sources/src1.yaml. It overrides path argument. Default: None.

append

Subcommand

Append data to source.

Show Arguments and Flags

name

Argument

required

Source name.

path

Argument

required

Path to a local file(s) or URL(s).

delete

Subcommand

Delete source data.

Show Arguments and Flags

name

Argument

required

Source name.

where

Flag

required

SQL WHERE condition to delete data. Ex.: logLevel=‘ERROR’

drop

Subcommand

Delete source.

Show Arguments and Flags

name

Argument

required

Source name.

--dry-run

Flag

Show execution plan without executing it.

--force

Flag

Force delete/overwrite even if data will be lost.

truncate

Subcommand

Truncate source (delete all data).

Show Arguments and Flags

name

Argument

required

Source name.

recalc

Subcommand

Recalculate AI columns.

Show Arguments and Flags

name

Argument

required

Source name.

cols

Argument

Columns to recalculate. Default: None.

wait

Flag

Wait for recalculation to finish. Default: False.

max_wait

Flag

Maximum time to wait for recalculation to finish. Default: 900 seconds.

job

Command

Source commands.

Show Subcommands

Subcommand

List jobs.

cancel

Subcommand

Cancel job.

Show Arguments and Flags

Argument

required

Job ID.

wait

Flag

Wait for job to be canceled. Default: False.

verbose

Global Flag

Set verbosity level, can be repeated.

On this page

Commands

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:

af

To get detailed information on a specific command, use the --help option.

For instance, learn more about the pipe command by running:

af pipe --help

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

config

Command

Configure your environment, such as credentials.

diff

Command

Diff between local and remote objects.

doctor

Command

Check your system for potential problems.

Show Flags

--fix

Flag

Fix issues automatically.

--list-checks

Flag

List available checks.

fmt

Command

Format local object files.

Show Flags

--dry-run

Flag

Show execution plan without executing it.

--overwrite

Flag

Overwrite existing local file(s) without confirmation.

generate

Command

Generate events.

Show Subcommands

events

Subcommand

Generate events based on a template or file.

Show Arguments and Flags

temp_name

Argument

required

Event template name or path to file.

--send

Flag

Source to send events to.

--limit

Flag

Limit amount of events. Default: -1

--eps

Flag

Send events per second. Default: 1

Subscribe to events.

Show Arguments and Flags

templ_name

Argument

required

Demo template name.

unsubscribe

Subcommand

Unsubscribe from events.

graph

Command

Dump graph of runtime objects in JSON format to file or stdout.

pipe

Command

Pipe commands.

Show Subcommands

delete

Subcommand

Delete pipe.

Show Arguments and Flags

name

Argument

required

Pipe name.

--force

Flag

Force delete/overwrite even if data will be lost.

--dry-run

Flag

Show execution plan without executing it.

Subcommand

List pipes.

materialize

Subcommand

Materialize draft pipe.

Show Arguments and Flags

name

Argument

required

Pipe name.

path

Argument

Target directory to create files in, (’-’ will dump to stdout). Default: ’-’ (stdout).

query

Subcommand

Query pipe data.

Show Arguments and Flags

name

Argument

required

Pipe name.

--format

Flag

Output data format. Options: json, ndjson. Default: ndjson.

--param

Flag

Set pipe parameters in the form of name=value. Can be repeated.

run

Subcommand

Run pipe and get data.

Show Arguments and Flags

name

Argument

required

Pipe name.

path

Argument

Path to a local object file(s), (’-’ will read objects from stdin). By default will look for a pushed pipe.

--format

Flag

Output data format. Options: json, ndjson. Default: ndjson.

--param

Flag

Set pipe parameters in the form of name=value. Can be repeated.

--node

Flag

Node name. Run only this node. By default, all nodes are run.

pull

Command

Pull objects from the runtime database.

Show Arguments

path

Argument

Target directory to create files in, (’-’ will dump to stdout). Default: ’-’ (stdout).

push

Command

Push object(s) into the runtime database.

Show Arguments and Flags

path

Argument

Target directory to read files from, (’-’ will read from stdin). Default: None

--dry-run

Flag

Show execution plan without executing it.

--force

Flag

Force delete/overwrite even if data will be lost.

--rename

Flag

Use rename strategy. Specify a single renamed object name and its new name.

source

Command

Source commands.

Show Subcommands

Subcommand

List sources.

create

Subcommand

Create source.

Show Arguments and Flags

events_path

Argument

required

Path to a local object file(s) or URL.

path

Argument

Target directory to create files in, (’-’ will dump to stdout). Default: ’-’ (stdout). Preserves workspace structure.

--out

Flag

New source output path, ex.: sources/src1.yaml. It overrides path argument. Default: None.

append

Subcommand

Append data to source.

Show Arguments and Flags

name

Argument

required

Source name.

path

Argument

required

Path to a local file(s) or URL(s).

delete

Subcommand

Delete source data.

Show Arguments and Flags

name

Argument

required

Source name.

where

Flag

required

SQL WHERE condition to delete data. Ex.: logLevel=‘ERROR’

drop

Subcommand

Delete source.

Show Arguments and Flags

name

Argument

required

Source name.

--dry-run

Flag

Show execution plan without executing it.

--force

Flag

Force delete/overwrite even if data will be lost.

truncate

Subcommand

Truncate source (delete all data).

Show Arguments and Flags

name

Argument

required

Source name.

recalc

Subcommand

Recalculate AI columns.

Show Arguments and Flags

name

Argument

required

Source name.

cols

Argument

Columns to recalculate. Default: None.

wait

Flag

Wait for recalculation to finish. Default: False.

max_wait

Flag

Maximum time to wait for recalculation to finish. Default: 900 seconds.

job

Command

Source commands.

Show Subcommands

Subcommand

List jobs.

cancel

Subcommand

Cancel job.

Show Arguments and Flags

Argument

required

Job ID.

wait

Flag

Wait for job to be canceled. Default: False.

verbose

Global Flag

Set verbosity level, can be repeated.

On this page

Commands

Commands

Get Started

Ingest

Workspace

Pipes

Sources

Diagnostic

CLI Reference

Commands

​Commands

Get Started

Ingest

Workspace

Pipes

Sources

Diagnostic

​Commands

Commands

Commands