Skip to content

Getting Started

Install the plugin, complete first-time setup, and run your first session.

Fastest path

  1. Install the plugin
  2. Enable extensions
  3. Run help me get setup
  4. Restart Copilot
  5. Try /gm

Install the Plugin

copilot plugin install https://community.opengroup.org/osdu/ui/ai-devops-agent/osdu-copilot-plugin.git
git clone git@community.opengroup.org:osdu/ui/ai-devops-agent/osdu-copilot-plugin.git
copilot plugin install ./osdu-copilot-plugin

Prerequisites

The setup skill handles all additional dependencies and configuration. Just ask Copilot to help you get set up.

First-Time Setup

1. Enable Extensions

Extensions are currently experimental and must be enabled in Copilot CLI. In a Copilot session, press /, select extensions, and set the mode to Load & Augment. This only needs to be done once.

2. Run Setup

Ask Copilot to set up the plugin:

❯ help me get setup

The setup flow will:

  1. Install extensions to ~/.copilot/extensions/ with npm dependencies
  2. Check CLI tools and report what is missing by tier
  3. Offer to install missing tools with user approval

3. Restart Copilot

Restart required

Extensions and PATH changes only take effect after restarting Copilot. If setup installed extensions or new CLI tools, exit and relaunch before continuing.

After updating the plugin (copilot plugin update osdu-plugin), run setup again to pick up new or changed extensions.

Verify Installation

copilot

You should see the plugin loaded with its skills and agents:

● Environment loaded: ... plugins, skills, agents

Your First Session

With the plugin installed and setup complete, you are ready to go. Try a few prompts:

# Morning briefing with goal progress and activity
/gm

# Check what is happening across OSDU services
What pipelines are failing?
Show me my open MRs

# Clone an OSDU repo and scan dependencies
osdu, clone the partition service
osdu, scan partition dependencies

# Ship local changes with review and quality checks
/send

The briefing pulls your goals from the vault (if configured), checks GitLab for open MRs and pipeline failures, and recommends what to work on first.

What next?


Optional: Create a CIMPL Environment

If you need live OSDU platform access, infrastructure workflows, or environment health checks, create a CIMPL environment:

cimpl, create a cimpl environment

The @cimpl agent will:

  1. Clone the cimpl-azure-provisioning repository to your workspace
  2. Verify Azure authentication (az login and azd auth login)
  3. Check for existing environments
  4. Run azd up to provision the full stack (AKS, networking, OSDU services)

Provisioning takes 20-30 minutes, depending on your Azure setup.

Already have an environment?

Skip this step. The plugin works with any existing CIMPL environment. Just make sure az and azd are authenticated.

Optional: Bootstrap the Brain

The brain vault is optional. Without it, skills still work; briefings print to the terminal, reports save to the working directory, and recommendations are based on session context only. When you are ready for persistent knowledge, initialize the vault and set up goals.

help me bootstrap my goals
Step What it asks What it creates
Quarter Auto-detected, confirmed by user
Goals (1-3) What do you want to accomplish this quarter? 01-goals/YYYY-QN-goals.md
Projects (1-3) What are you actively working on? 02-projects/{slug}.md
Re-index Automatic QMD vectors updated

What makes a good goal?

Goals should be specific and measurable: "Get partition service tests to 90% pass rate on Azure" is better than "Improve test coverage." Each goal gets 2-3 key results that the briefing can track progress against.

QMD enables hybrid search over your Obsidian vault. It is optional and currently available on macOS and Linux only. The plugin works without it, but vault search will not be available until QMD is installed and indexed.

# Install QMD globally
npm install -g @tobilu/qmd

# Index your vault after bootstrapping the brain
# Default vault location: ~/.osdu-brain (override with $OSDU_BRAIN)
qmd collection add ~/.osdu-brain --name brain
qmd embed

Windows

QMD is currently not supported on Windows. The plugin still works without it; only vault search is unavailable.

Reference: Extensions

The plugin ships with two Copilot CLI extensions that are installed to ~/.copilot/extensions/ during setup. Most users do not need to configure these directly.

Extension Purpose
Cron Session-scoped task scheduling
OSDU Live OSDU platform access across six services

OSDU Extension

The OSDU extension connects to a live OSDU platform using Keycloak client credentials. Configuration is auto-discovered from your workspace after creating an environment with the @cimpl agent.

# Switch between environments if you have multiple
azd env select <your-environment>

Or set environment variables manually:

Variable Description Default
OSDU_BASE_URL OSDU platform base URL From azd
KEYCLOAK_URL Keycloak authentication URL From azd
KEYCLOAK_REALM Keycloak realm osdu
KEYCLOAK_CLIENT_ID Keycloak client ID datafier
KEYCLOAK_CLIENT_SECRET Keycloak client secret From azd
OSDU_DATA_PARTITION Data partition ID From azd