-
Notifications
You must be signed in to change notification settings - Fork 75
docs: rewrite README as landing page, add 8 user-facing doc pages #62
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
ae50b81
docs: rewrite README as landing page, add 8 user-facing doc pages
b4c7028
docs: address Copilot review comments
2a8dda1
docs: address PR review — fix doc updater refs, add Azure eval auth note
dc35efb
docs: fix fabricated @anthropic-ai package name in CI examples
37a2da8
docs: fix policy examples (add name field, remove criteria.add), add …
98c721b
docs: fix pr --provider azure, --policy wording, exit code, .ts polic…
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| # At Scale | ||
|
|
||
| > [AgentRC](https://github.com/microsoft/agentrc) — prime your repositories for AI-assisted development. | ||
|
|
||
| Everything that works on one repo also works on hundreds. AgentRC supports batch processing across GitHub organizations and Azure DevOps projects. | ||
|
|
||
| ## Batch processing | ||
|
|
||
| Generate instructions and configs for multiple repos in one pass: | ||
|
|
||
| ```bash | ||
| # Interactive TUI — select repos from your org | ||
| npx github:microsoft/agentrc batch | ||
|
|
||
| # Headless — GitHub repos | ||
| npx github:microsoft/agentrc batch owner/repo1 owner/repo2 | ||
|
|
||
| # Headless — Azure DevOps repos | ||
| npx github:microsoft/agentrc batch org/project/repo1 org/project/repo2 --provider azure | ||
| ``` | ||
|
|
||
| Repos can also be piped via stdin (one per line): | ||
|
|
||
| ```bash | ||
| gh repo list my-org --json nameWithOwner -q '.[].nameWithOwner' \ | ||
| | npx github:microsoft/agentrc batch | ||
| ``` | ||
|
|
||
| ### Options | ||
|
|
||
| | Flag | Default | Description | | ||
| | ----------------- | ------------------- | -------------------- | | ||
| | `--output <path>` | | Write results JSON | | ||
| | `--provider <p>` | `github` | `github` or `azure` | | ||
| | `--model <name>` | `claude-sonnet-4.6` | Model for generation | | ||
| | `--branch <name>` | | Branch name for PRs | | ||
|
|
||
| ## Consolidated readiness | ||
|
|
||
| Get a single readiness report across all repos in your org: | ||
|
|
||
| ```bash | ||
| npx github:microsoft/agentrc batch-readiness --output team.html | ||
| ``` | ||
|
|
||
| The HTML report shows per-repo scores, trends, and which repos need attention. | ||
|
|
||
| | Flag | Default | Description | | ||
| | -------------------- | ------- | -------------------------------------------- | | ||
| | `--output <path>` | | Write HTML report | | ||
| | `--policy <sources>` | | Comma-separated policy paths or npm packages | | ||
|
|
||
| ## Automated PRs | ||
|
|
||
| Clone a repo, generate configs, and open a PR — all in one command: | ||
|
|
||
| ```bash | ||
| # GitHub | ||
| npx github:microsoft/agentrc pr owner/repo-name | ||
|
|
||
| # Azure DevOps | ||
| npx github:microsoft/agentrc pr org/project/repo --provider azure | ||
| ``` | ||
|
|
||
| | Flag | Default | Description | | ||
| | ----------------- | ----------------------- | -------------------- | | ||
| | `--branch <name>` | `agentrc/add-ai-config` | Branch name | | ||
| | `--provider <p>` | | `github` or `azure` | | ||
| | `--model <name>` | `claude-sonnet-4.6` | Model for generation | | ||
|
|
||
| ## Authentication | ||
|
|
||
| | Provider | Required env var | | ||
| | ------------ | --------------------------------------------------- | | ||
| | GitHub | `GITHUB_TOKEN` or `GH_TOKEN`, or `gh` CLI logged in | | ||
| | Azure DevOps | `AZURE_DEVOPS_PAT` or `AZDO_PAT` | | ||
|
|
||
| ## Repo format | ||
|
|
||
| | Provider | Format | Example | | ||
| | ------------ | ------------------ | -------------------------- | | ||
| | GitHub | `owner/repo` | `microsoft/agentrc` | | ||
| | Azure DevOps | `org/project/repo` | `contoso/platform/backend` | | ||
|
|
||
| ## Next steps | ||
|
|
||
| - [Policies](policies.md) — enforce org-specific standards across all repos | ||
| - [CI Integration](ci-integration.md) — add readiness gates to every repo's pipeline | ||
| - [Commands](commands.md) — full CLI reference for batch, batch-readiness, and pr |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| # CI Integration | ||
|
|
||
| > [AgentRC](https://github.com/microsoft/agentrc) — prime your repositories for AI-assisted development. | ||
|
|
||
| AgentRC commands return structured output and exit codes designed for CI pipelines. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - **Node.js 20+** on the runner | ||
| - **Auth token** — GitHub: `GITHUB_TOKEN` or `GH_TOKEN`. Azure DevOps: `AZURE_DEVOPS_PAT` or `AZDO_PAT`. | ||
| - **Copilot CLI** — required for `eval` (it calls the Copilot SDK). Not needed for `readiness`. See the [VS Code Copilot Chat extension](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot-chat) docs for installation. | ||
|
|
||
| > `readiness` is a pure static analysis — it works anywhere Node runs. `eval` invokes AI models via the Copilot SDK, so the runner needs Copilot CLI installed and authenticated. | ||
|
|
||
| ## Readiness gate | ||
|
|
||
| Fail if the repo drops below a maturity level: | ||
|
|
||
| ```bash | ||
| agentrc readiness --fail-level 3 --json | ||
| ``` | ||
|
|
||
| Exits with code 1 if the readiness level is below 3. The `--json` flag outputs a machine-readable result to stdout. | ||
|
|
||
| ## Eval gate | ||
|
|
||
| Fail if instruction quality drops below a pass rate: | ||
|
|
||
| ```bash | ||
| agentrc eval agentrc.eval.json --fail-level 80 --json | ||
| ``` | ||
|
|
||
| Exits with code 1 if the pass rate is below 80%. | ||
|
|
||
| ## GitHub Actions | ||
|
|
||
| ```yaml | ||
| name: AgentRC checks | ||
| on: [pull_request] | ||
|
|
||
| jobs: | ||
| readiness: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| - uses: actions/setup-node@v4 | ||
| with: | ||
| node-version: 20 | ||
|
|
||
| - name: Check readiness | ||
| run: npx github:microsoft/agentrc readiness --fail-level 3 --json | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - name: Run eval | ||
| run: npx github:microsoft/agentrc eval --fail-level 80 --json | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| # eval requires the GitHub Copilot CLI to be installed | ||
| # and authenticated on the runner (copilot → /login) | ||
| ``` | ||
|
digitarald marked this conversation as resolved.
|
||
|
|
||
| ## Azure Pipelines | ||
|
|
||
| ```yaml | ||
| trigger: | ||
| - main | ||
|
|
||
| pool: | ||
| vmImage: ubuntu-latest | ||
|
|
||
| steps: | ||
| - task: NodeTool@0 | ||
| inputs: | ||
| versionSpec: "20.x" | ||
|
|
||
| - script: npx github:microsoft/agentrc readiness --fail-level 3 --json | ||
| displayName: Check readiness | ||
| env: | ||
| GITHUB_TOKEN: $(GITHUB_TOKEN) # for GitHub-hosted repos | ||
| # AZURE_DEVOPS_PAT: $(AZURE_DEVOPS_PAT) # for Azure DevOps repos | ||
|
|
||
| - script: npx github:microsoft/agentrc eval --fail-level 80 --json | ||
| displayName: Run eval | ||
| env: | ||
| GITHUB_TOKEN: $(GITHUB_TOKEN) | ||
| # AZURE_DEVOPS_PAT: $(AZURE_DEVOPS_PAT) | ||
| # eval requires the GitHub Copilot CLI to be installed | ||
| # and authenticated on the runner (copilot → /login) | ||
| ``` | ||
|
|
||
| ## Applying policies in CI | ||
|
|
||
| Use a policy to enforce org-specific standards: | ||
|
|
||
| ```bash | ||
| npx github:microsoft/agentrc readiness --policy ./policies/strict.json --fail-level 3 --json | ||
| ``` | ||
|
|
||
| ## Any CI system | ||
|
|
||
| The pattern works in any CI that has Node.js: | ||
|
|
||
| ```bash | ||
| npx github:microsoft/agentrc readiness --fail-level 3 --json | ||
| npx github:microsoft/agentrc eval --fail-level 80 --json | ||
| ``` | ||
|
|
||
| Both commands exit 0 on success and 1 when `--fail-level` is breached. Use `--json` to get structured output for downstream tooling. | ||
|
|
||
| ## Output format | ||
|
|
||
| Both commands output a `CommandResult<T>` envelope when `--json` is set: | ||
|
|
||
| ```json | ||
| { | ||
| "ok": true, | ||
| "status": "success", | ||
| "data": { ... } | ||
| } | ||
| ``` | ||
|
|
||
| Status values: `"success"`, `"partial"`, `"noop"`, `"error"`. The process exit code is 0 for success and 1 when `--fail-level` is breached or a command error occurs. | ||
|
|
||
| ## Next steps | ||
|
|
||
| - [At Scale](at-scale.md) — batch processing and automated PRs across orgs | ||
| - [Policies](policies.md) — create org-specific readiness policies | ||
| - [Commands](commands.md) — full flag reference for `readiness` and `eval` | ||
| - [Concepts](concepts.md) — understand maturity levels and pass rates | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.