Integrating GitHub Copilot with QuickBooks data via CData CLI
GitHub Copilot gives developers direct access to a powerful AI agent that can autonomously complete multi-step tasks, reading and modifying files, running shell commands, managing pull requests on GitHub, and delegating work to specialized custom agents, all driven by natural language instructions. Its support for agent skills and custom instructions makes it well-suited for structured, tool-driven workflows, making it a natural fit for connecting to external data sources through CData CLI.
By describing your data goals in plain language, GitHub Copilot can handle the full setup process, from driver configuration and license activation to connection creation and query execution, without manual intervention at each step.
This article details step-by-step directions for how to connect QuickBooks data to GitHub Copilot through CData CLI.
Prerequisites
-
GitHub Copilot installed (either Terminal CLI or IDE Extension)
- Terminal CLI: Installing GitHub Copilot CLI - GitHub Docs
- IDE Extension (VS Code): GitHub Copilot - AI coding built your way
- CData CLI installed
- Access to QuickBooks
About QuickBooks Data Integration
CData simplifies access and integration of live QuickBooks data. Our customers leverage CData connectivity to:
- Access both local and remote company files.
- Connect across editions and regions: QuickBooks Premier, Professional, Enterprise, and Simple Start edition 2002+, as well as Canada, New Zealand, Australia, and UK editions from 2003+.
- Use SQL stored procedures to perform actions like voiding or clearing transactions, merging lists, searching entities, and more.
Customers regularly integrate their QuickBooks data with preferred tools, like Power BI, Tableau, or Excel, and integrate QuickBooks data into their database or data warehouse.
Getting Started
Step 1: Download the skill (one-time setup)
Always use CData CLI with the official skill.
-
The official CData CLI Skill is available on GitHub and installs through npx skills in the terminal:
npx skills add CDataSoftware/cli-skills -
Follow the prompts in the terminal to install for GitHub Copilot.
Step 2: Set up the project directory
Create a project directory to contain all project files. Below are examples for using GitHub Copilot in either the Terminal or an IDE Extension (VS Code):
GitHub Copilot in Terminal CLI
Navigate to the directory within the terminal and start a session with the copilot command:
GitHub Copilot in VS Code
Select the working directory within VS Code and start a chat session:
Step 3: Establish the driver and connection
Describe what you want to accomplish in this session with the CLI and QuickBooks data.
I would like to build a command line app that connects to QuickBooks data and checks for updates from Customers. Make sure to include data from important columns like Name and CustomerBalance.
This prompt automatically loads the skill and kicks off the following process. You can always manually prompt the agent for each of the following steps.
- Driver setup: GitHub Copilot checks for an existing CData QuickBooks driver, or searches and downloads a new one:
cdatacli drivers listcdatacli drivers search --driver "QuickBooks"cdatacli drivers download --artifact-id <artifact-id>- Activation: Activate the QuickBooks driver with a single command for a trial or full license:
cdatacli drivers activate "QuickBooks" --name "<name>" --email "<email>" --trialcdatacli drivers activate "QuickBooks" --name "<name>" --email "<email>" --key "<product-key>"- Establish the QuickBooks connection: Check for existing QuickBooks connections or create a new one:
cdatacli connection listcdatacli connection create --driver QuickBooks --name my_quickbooks_connection --connectionstring "Prop1=value1;Prop2=value2;..."- Create a QuickBooks skill (if applicable): CData provides driver instructions for popular sources. You can use these to generate a source-specific skill file that guides the agent through best practices for the driver.
-
Run the following command and save the output to your skills directory, either at the project level or globally. (Note: If you receive a "No instructions available for QuickBooks" message, no driver instructions exist for this source. You can continue using the main driver skill.)
cdatacli drivers skill "QuickBooks" > ~/skills/cdata-quickbooks/SKILL.md
Step 4: Query QuickBooks data
With the CData driver fully configured, your agent can now execute queries and write code against live QuickBooks data:
cdatacli query sql --connection my_quickbooks_connection --sql "SELECT * FROM Customers"
Query QuickBooks data directly from your terminal with CData CLI
GitHub Copilot and CData CLI together give your AI coding agent a direct path to live QuickBooks data without custom middleware, scheduled syncs, or manual setup at each step. Describe your goal in plain language, and the agent handles driver configuration, connection setup, and query execution from start to finish in the terminal.
Download the free CData CLI and start a free, 30-day trial of the CData JDBC Driver for QuickBooks today.