Integrating GitHub Copilot CLI with OData services via CData CLI

GitHub Copilot CLI is the terminal interface for GitHub Copilot, giving developers direct access to an AI agent without leaving the command line. It can autonomously complete multi-step tasks driven by natural language instructions, including reading and modifying files, running shell commands, managing pull requests on GitHub, and delegating work to specialized custom agents. 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 CLI 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 OData services to GitHub Copilot CLI through CData CLI.

Prerequisites

1. GitHub Copilot CLI installed
2. CData CLI installed
3. Access to OData

Getting Started

---

Step 1: Download the skill (one-time setup)

Always use CData CLI with the official skill.

1. The official CData CLI Skill is available on GitHub and installs through npx skills in the terminal:

   npx skills add CDataSoftware/cli-skills

2. 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.

1. Navigate to the directory within the terminal and start a session with the copilot command:

Step 3: Establish the driver and connection

Describe what you want to accomplish in this session with the CLI and OData data.

I would like to build a command line app that connects to OData services and checks for updates from Orders. Make sure to include data from important columns like OrderName and Freight.

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.

1. Driver setup: GitHub Copilot CLI checks for an existing CData OData driver, or searches and downloads a new one:

• cdatacli drivers list

• cdatacli drivers search OData

• cdatacli drivers download --artifact-id 

2. Activation: Activate the OData driver with a single command for a trial or full license:

• cdatacli drivers activate OData --name "" --email "" --trial

• cdatacli drivers activate OData --name "" --email "" --key ""

3. Establish the OData connection: Check for existing OData connections or create a new one:

• cdatacli connection list

• cdatacli connection create --driver OData --name  --connectionstring 

4. Create a OData 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 OData" message, no driver instructions exist for this source. You can continue using the main driver skill.)

  cdatacli drivers skill OData > ~/skills/cdata-OData/SKILL.md

Step 4: Query OData data

With the CData driver fully configured, your agent can now execute queries and write code against live OData data:

cdatacli query sql --connection  --sql 

Query OData data directly from your terminal with CData CLI

GitHub Copilot CLI and CData CLI together give your AI coding agent a direct path to live OData 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 OData today.