Academy
CLI and MCP

CLI Dattos: commands and capabilities

This article is the reference for CLI Dattos commands, organized by area. All of them accept --help for complete flag documentation, and dattos status-glossary explains the meaning of any status returned by the platform. For installation and authentication, see "CLI Dattos: installation and first steps".

Current scope: the CLI covers Process Automation (flows, executions, reconciliation, reports) and platform administration. The Account Verification and Task Management modules are not yet available through the CLI — coverage is planned as the product evolves.

Flows and execution (dattos etl)

The core group of the CLI — covers the lifecycle of data preparation and reconciliation flows:

  • Create and build with Dattos AI: etl create --name <nome> creates the analysis; etl add-source --etl <id> --file <arquivo> adds sources (xlsx, csv, pdf, xml); etl pipeline create "<descrição em linguagem natural>" --etl <id> builds the complete flow with artificial intelligence (accepts --rules <documento> with the business rules). The shortcut etl new does everything in one call.

  • Run: etl start <id> --date <AAAA-MM-DD> triggers the execution for a reference date; --file uploads the file first, --wait follows it until completion, --incremental preserves data already loaded.

  • Track and manage: etl execution-status <id> --date <data>, etl list, etl get <id>, etl resolve <código> (translates code to identifiers), etl datasources <id>, etl publish <id> (promotes the draft to a published version) and etl activate/etl deactivate.

  • Backup and restore: etl download <id> downloads the flow's .xdtt blueprint; etl upload <id> --file <blueprint> restores it.

  • Advanced build: to assemble the flow step by step through scripting, there are etl add-step, etl connect, etl set-params, etl add-matching, etl components (catalog and parameters for each step), etl formulas (Dattos Formula reference), etl sql-help and etl step-data (sample output from a step).

Result queries

  • dattos loads: loads get <análise> <data> returns the load and its datasets; loads list-dates lists the reference dates with data.

  • dattos datasets: datasets search <análise> <load> <dataset> queries the result rows, with pagination and filters in JSON.

  • dattos matching: matching status shows the reconciliation totals (reconciled, pending), matching summary shows the summary by column, and matching get shows the records.

Export (dattos reports)

  • reports generate <análise> --load-id <id> --dataset-id <id> --format csv|xlsx — asynchronous generation.

  • reports status tracks it and reports download <análise> <reportId> --output <arquivo> downloads the result.

Format limit: above 1 million rows, export is available only in CSV.

Administration

  • dattos users: list, create, update, block, and delete users; users set-roles defines the roles.

  • dattos roles: management of privacy roles — CRUD, folder scope (roles folders) and reconciliation approval levels (roles approval-levels).

  • dattos connectors: database connectors — create, test (connectors test), activate/deactivate.

  • dattos calendars: query execution calendars.

  • dattos batch: bulk operations — batch batch-start --ids <lista> --date <data> runs multiple analyses in sequence; batch batch-create --file <usuarios.json> creates users in bulk.

  • dattos folders: browsing and selecting the folder context.

Utilities

  • dattos doctor [--deep] — diagnostics for configuration, connectivity, and authentication.

  • dattos config profile list|switch — profiles for multiple instances/environments.

  • dattos cache — management of the local query cache (5-minute TTL; write operations invalidate it automatically).

  • dattos mcp install <ferramenta> — configures the MCP server in artificial intelligence assistants (see the MCP article).

  • dattos version and dattos status-glossary.

Behavior and limits

  • Accepted upload files: .csv, .edi, .ofx, .pdf, .rem, .ret, .txt, .xlsx, .xls, .xlsb, .xml.

  • Request limit: when receiving HTTP 429, the CLI automatically retries up to 3 times with progressive waiting (5s, 10s, 20s).

  • Timeout: 30s for standard calls; 120s for upload and download; 10 minutes for artificial intelligence flows (streaming).

  • Exit codes: 0 success, 1 API error, 2 authentication/configuration — errors are returned in JSON on stderr with next_step and correlation_id for support.

  • CLI Dattos: installation and first steps

  • Connect artificial intelligence assistants via MCP

  • Introduction to integrations

Was this helpful?