Skip to main content

AI Agent Docs

If you use an AI assistant to set up or troubleshoot Integration CLI, give it the published AI documentation URL first. The URL keeps the assistant pointed at the newest CLI documentation instead of an older downloaded copy.

Use them when you want an assistant to help with:

  • Creating a mapping.yml file.
  • Choosing optimus check options.
  • Explaining result CSV columns.
  • Troubleshooting authentication, CSV parsing, folder mode, or exit codes.
  • Understanding support logs and saved validation state.

You do not need these files to run Integration CLI. They are only for giving an AI assistant better context.

Available Files​

FileUse it for
/llms.txtBest default for agents that can open URLs. It tells the assistant which CLI docs to read and in which order.
/llms-full.txtBest fallback when the assistant cannot browse multiple documentation pages or needs one complete CLI reference. Share the URL when possible; download it only for offline or fixed-version work.

What This Means​

  • Use these files when you want help with the CLI: installing it, configuring CSV mappings, running optimus check, reading result CSVs, using folder mode, or troubleshooting a failed run.
  • Do not expect API endpoint schemas, request bodies, or response models in these files.
  • If you are building a direct HTTP integration instead of using the CLI, use the Integration API documentation.
  • Prefer sharing the published URL over uploading a downloaded copy. Downloaded files can become outdated.
  • The published files are rebuilt from the CLI documentation whenever the documentation site is built, so they stay aligned with the published CLI docs.

You do not need to choose between the CLI docs and the AI files. The AI files are just a machine-readable copy of the CLI docs for assistants.

When giving a URL to an agent, include a short instruction such as:

Use this Integration CLI documentation URL to help configure and troubleshoot optimus check: <llms-url>
Do not invent CLI options, YAML keys, output columns, or status values that are not present in the documentation.
Do not include real tok_optimus_ token values in examples.

Security Notes​

Do not paste real Personal Access Tokens, customer CSV data, VAT IDs from private data, support logs, or result files into public AI tools.

Use placeholders such as:

<token>
customers.csv
mapping.yml