User guide

Installing & configuring AI Copilot

Everything needed to get from a license key to a working chat panel in your Magento admin — Composer or manual install, then connecting your AI provider and locking down access.

Requirements

1. Install the module

Download the module as a .zip from your account dashboard after purchase and install it into app/code.

1. 1Go to your account dashboard and download the module .zip.
2. 2Extract it into app/code/TVTCommerce/AiCopilot in your Magento root (create the folders if they don't exist).
3. 3From your Magento root, run:

   bin/magento module:enable TVTCommerce_AiCopilot
   bin/magento setup:upgrade
   bin/magento setup:di:compile
   bin/magento cache:flush

4. 4Confirm it's enabled: bin/magento module:status TVTCommerce_AiCopilot should show enabled.

2. Configure: activate your license

In the Magento admin, go to Stores > Configuration > TVTCommerce > AI Copilot > License and paste the license key emailed to you at purchase. Save — the module validates the key against your domain automatically.

3. Configure: connect an AI provider

Under the same configuration section, open the AI Provider tab and pick one:

Paste your API key into the matching field and save. Nothing is sent to TVT Commerce — the key is stored in your own Magento configuration and used to call the provider directly from your server.

4. Configure: permissions & ACL

Under System > Permissions > User Roles, AI Copilot exposes two separate ACL resources so you can split access by role:

• AI Copilot > Chat access — lets an admin open the panel and ask questions (read-only tools only).
• AI Copilot > Write access — additionally allows confirming writes (product edits, CMS updates, bulk changes).

Grant chat-only access to support/ops staff who should be able to look things up but never change data; grant both to store owners and trusted admins.

5. Configure: rate limiting

Under AI Provider > Rate Limiting, set a per-admin requests-per-minute cap. This protects a shared provider quota from one runaway loop or an admin leaving the panel open in a busy tab.

6. Configure: daily digest (email & Slack)

Under AI Copilot > Digest, turn on the morning summary — sales vs. yesterday, orders stuck in review, and failed cron jobs from the last 24 hours.

• Email: enter the recipient address(es); uses your store's existing outbound mail configuration.
• Slack: paste an incoming webhook URL from your Slack app settings.

Troubleshooting

• Panel doesn't appear in the admin: confirm the module is enabled (bin/magento module:status TVTCommerce_AiCopilot) and that your admin user has Chat access granted.
• "Invalid license" on save: double-check you copied the full key with no trailing space, and that the domain you're activating matches your production URL exactly.
• Chat responds but can't read store data: Ollama and Custom endpoints don't call tools yet — check which provider is selected under AI Provider.
• Still stuck? Contact us and pick Technical Support — our AI-assisted contact form routes it straight to the right queue.