Skip to main content

System Administration (CLI)

On a self-hosted deployment you own the system-wide operational settings, and you can change them live, without asking us to redeploy. You administer these with the DocAI Fabric CLI, which you install straight from your own running deployment so it always matches your version.

This page covers the one-time setup: installing the CLI, pointing it at your deployment, and optionally enabling an AI agent to drive it. Once that is done, each individual task has its own short guide, starting with Configure SMTP.

Who can do this​

System settings are system-wide, not tenant settings. They are reachable only with your deployment's admin API key (ADMIN_API_KEY). No regular user, not even a tenant administrator, can see or change them. Keep the admin key safe.

How you obtain this key depends on how your deployment is run:

  • Managed in Azure by the DocAI Fabric team: we provision the admin key as part of your deployment and share it with you securely during onboarding.
  • Self-hosted on-premises: you create ADMIN_API_KEY yourself when you deploy (it is one of your deployment environment variables), so you already hold it.

Step 1: Install the CLI from your deployment​

The CLI is served by your deployment, so the version always matches the running system.

One line:

curl -fsSL https://app.docaifabric.com/cli/install.sh | sh

This installs two equivalent commands: docaifabric and the short alias da. Check it:

da --help

Prefer pip yourself? Ask the deployment for the exact install command (it includes the current version), then run it:

curl -s https://app.docaifabric.com/cli/info
# use the "install_command" value it returns, for example:
# pip install https://app.docaifabric.com/cli/download/docaifabric_cli-1.0.0-py3-none-any.whl

Step 2: Point the CLI at your deployment​

The CLI needs your deployment URL and admin key. Set them as environment variables:

export DOCAIFABRIC_API_URL="https://app.docaifabric.com"
export DOCAIFABRIC_ADMIN_API_KEY="your-admin-api-key"

Or put them in a .env.cli file in your working directory:

DOCAIFABRIC_API_URL=https://app.docaifabric.com
DOCAIFABRIC_ADMIN_API_KEY=your-admin-api-key

Step 3: Enable your AI agent (optional)​

If you use an AI coding agent such as Claude Code, the CLI ships a skill that teaches the agent to drive these commands (configure SMTP, send a test email, troubleshoot, find logs). Install it into your project:

da skill install

Use da skill install --user to install it for every project on your machine. After installing, reopen the folder in your agent so it discovers the skill. You can then simply ask, for example, "configure SMTP for this deployment" or "why are invitation emails not sending", and the agent will use the CLI for you.

What you can administer​

Each operation has its own short guide:

Set them up in that order. The links in your emails depend on the application URL, and creating a tenant sends an email, so a working mail setup comes first.

More operations will be added here over time.

Logs are not part of the CLI: you read them with the tools your platform already gives you. See Application Logs for an Azure subscription, or Application Logs (On-Premises) for a Docker install.

Troubleshooting the CLI​

  • 401 or 403: your admin key is missing or wrong. Check DOCAIFABRIC_ADMIN_API_KEY matches the deployment's ADMIN_API_KEY.
  • Connection refused or timeout: check DOCAIFABRIC_API_URL points at your running deployment and is reachable from where you run the CLI.
  • 404 on an admin route: your deployment predates this feature. Update to a build that includes the system administration API.

For problems specific to a task (for example SMTP), see that task's own guide.