@softhouse-malmo/quiz-agent

Install Quiz Agent integration scaffolding in a GitHub or Azure DevOps Git repository.

Install

Run this from the repository where you want Quiz Agent files installed:

npm install --save-dev @softhouse-malmo/quiz-agent

Then start setup:

npx quiz-agent init

The CLI asks for a repository path. Press Enter to use the current directory.

To skip the prompt, provide the repository path explicitly:

npx quiz-agent init --repo C:\work\my-repository

Requirements

Before running init, the selected directory must have:

1. Git installed and available as git.
2. An initialized Git repository.
3. An origin remote that points to GitHub or Azure DevOps.

Example GitHub repository setup:

git init
# Replace both ALL-CAPS values with your actual GitHub owner and repository name.
git remote add origin https://github.com/YOUR_GITHUB_OWNER/YOUR_REPOSITORY.git
npx quiz-agent init

Example Azure DevOps repository setup:

git init
# Replace all three ALL-CAPS values with your Azure DevOps organization, project, and repository name.
git remote add origin https://dev.azure.com/YOUR_AZURE_ORGANIZATION/YOUR_AZURE_PROJECT/_git/YOUR_REPOSITORY
npx quiz-agent init

What init creates

For GitHub:

.quiz-agent.yml
.github/workflows/quiz-agent.yml

For Azure DevOps:

.quiz-agent.yml
.azure-pipelines/quiz-agent.yml

For Bitbucket, the CLI reports that installation is unsupported and creates no files.

Context command

Use the local development command to print deterministic Git context between two revisions:

npx quiz-agent context `
  --repo C:\work\my-repository `
  --base <base-sha-or-revision> `
  --head <head-sha-or-revision>

Example:

npx quiz-agent context --repo . --base main --head HEAD

AI integration status

No AI integration is included. The future provider-neutral integration socket is QuizGenerator in packages/core/src/generation/quiz-generator.ts in the Quiz Agent source repository. The current deterministic local option is:

QUIZ_GENERATOR=stub