Docs
Command Line
Look up any agent command, with what it does, how to invoke it, and every flag it accepts.
Look up a command here when you know roughly what you want to do and need the exact invocation: the arguments it takes, the flags it accepts, and what each one defaults to.
If you are trying to accomplish something rather than look something up (installing the agent, registering it, checking its health), start with the CLI and agent guides instead.
Sort or search the table to find a command, then follow it through for its full reference.
| Command | Description |
|---|---|
add-job | Add a job to the project configuration. |
add-target | Add a target data platform to the project configuration. |
advise | Profile source tables and generate PCF configuration recommendations. |
channel | Keep the agent connected so the platform can dispatch runs. |
commit | Commit the bound project’s config to Git (git-lite push). |
completion | Generate the autocompletion script for the specified shell. |
contract-gate | Compare two contract versions and check the declared version bump. |
deploy | Deploy a data contract to a target database. |
docs | Generate and verify project documentation. |
docs check | Verify the project’s committed Markdown documentation is up to date. |
docs generate | Generate the project’s Markdown documentation. |
doctor | Diagnose the agent’s install + posture. |
download | Download the latest agent binary. |
import | Create a data contract for a given source. |
init | Initialize a new project configuration. |
init-agent | Initialize the agent identity and generate its keypair. |
lint | Validate syntax of the project configuration. |
plugin | Plugin commands. |
plugin import | Import and install a specific plugin. |
plugin install | Install configured plugins. |
plugin list | List available plugins. |
plugin update | Update installed plugins to latest version. |
pull | Pull the environment’s committed config from Git (git-lite pull). |
register | Register this agent with your organization. |
sql | Work with the SQL Amfelt generates for your warehouse. |
sql check | Check the generated SQL is still up to date. |
sql generate | Write out the generated SQL for this project. |
sync | Execute a pipeline job defined in amfelt.yaml. |
template | Customize the SQL a target plugin generates. |
template eject | Copy a target plugin’s SQL template into your project. |
template validate | Check the SQL templates you have customized. |
validate | Validate a source against a data contract. |
version | Show version information. |
Global flags
Every command accepts these, and each command page repeats them under Global flags:
| Flag | Description |
|---|---|
--config | Directory or filename of the application configuration |
--amfelt-dir | Directory for the agent’s workspace: downloaded plugins and the project files a pull materializes (default .amfelt, resolved against the working directory). It does not move the agent identity: the keypair, the agent id, the organization id, and projects.yaml live under $AMFELT_DIR, or ~/.amfelt when that is unset |
-l, --level | Minimum log level: error, warn, info, or debug |
-f, --format | Log format: default, pretty, or json |
-v, --verbose | Verbose logging |
--amfelt-dir moves the workspace root only; $AMFELT_DIR moves the identity root as well.
Where the agent keeps its state
has the full resolution order and the layout worth backing up.
Last updated on October 28, 2026