Skip to content

Commit 9cf7812

Browse files
pdebruinpdebruin
authored
Merge pull request #17 from mikekinsman/readme-refresh
Refresh README with improved structure and updated links
2 parents efca137 + 1162b97 commit 9cf7812

1 file changed

Lines changed: 48 additions & 34 deletions

File tree

‎README.md‎

Lines changed: 48 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,71 @@
11
# Microsoft Build CLI
22

3-
The Microsoft Build CLI is a [GitHub Copilot CLI](https://docs.github.com/en/copilot/github-copilot-in-the-cli) skill that connects your local project to the Microsoft Build session catalog. It reads your dependencies, finds relevant sessions, and helps you plan your Build experience — all from your terminal.
3+
A [GitHub Copilot CLI](https://github.com/features/copilot/cli/) skill that connects your local project to the Microsoft Build session catalog. It reads your dependencies, finds relevant sessions, and helps you act on what you learn — all from your terminal.
44

5-
## Get Started
5+
> [!NOTE]
6+
> Build-CLI targets **Build 2026** and also indexes past events (Build 2025, Ignite 2025). It supports any future event that follows the same catalog endpoint pattern. It is not a replacement for the event app or session browser — it's a developer-first complement to them.
7+
8+
## Quick Start
69

710
1. Open **GitHub Copilot CLI** in any project and run:
11+
```
12+
/plugin install microsoft/Build-CLI
13+
```
14+
2. Restart your Copilot CLI session:
15+
```
16+
/restart
17+
```
18+
3. Try:
19+
```
20+
What Build sessions are relevant to my project?
21+
```
822

9-
```
10-
/plugin install microsoft/Build-CLI
11-
```
23+
The skill reads `package.json`, `requirements.txt`, `.csproj`, `go.mod`, and other dependency files, maps them to Microsoft products, and searches the live Build 2026 session catalog.
1224

13-
2. Restart your Copilot CLI session (exit and reopen).
25+
## Requirements
1426

15-
3. Try:
27+
- [GitHub Copilot CLI](https://github.com/features/copilot/cli/) installed and authenticated
28+
- **Node.js 22+** (recommended) — enables the `@microsoft/events-cli` for faster local search and caching. Without Node.js, the skill falls back to direct HTTP and everything still works.
1629

17-
```
18-
What Build sessions are relevant to my project?
19-
```
30+
## What You Can Do
2031

21-
The skill reads your `package.json`, `requirements.txt`, `.csproj`, or other dependency files, maps them to Microsoft products, and searches the live Build 2026 session catalog for matches.
32+
### Before Build — plan your schedule
2233

23-
## What You Can Do
34+
| Ask the skill to… | Example |
35+
|------------------------------------------|-------------------------------------------------------|
36+
| Find sessions for your project | *"What Build sessions should I attend?"* |
37+
| See what's new for your tech stack | *"What's new at Build for Azure Cosmos DB?"* |
38+
| Look up a session by code | *"Tell me about session BRK155"* |
2439

25-
| Ask the skill to... | Example |
26-
|---------------------|---------|
27-
| Find sessions for your project | *"What Build sessions should I attend?"* |
28-
| See what's new for your tech stack | *"What's new at Build for Azure Cosmos DB?"* |
29-
| Look up a session by code | *"Tell me about session BRK155"* |
30-
| Get next steps after a session | *"What should I do after session BRK155?"* |
31-
| Scaffold a project from a session | *"Scaffold a project from session BRK155"* |
32-
| Log notes during the event | *"Log a note from session BRK155: great agent demo"* |
40+
### During Build — capture what matters
3341

34-
## How It Works
42+
| Ask the skill to… | Example |
43+
|------------------------------------------|-------------------------------------------------------|
44+
| Log notes tied to a session | *"Log a note from session BRK155: great agent demo"* |
45+
| Get next steps after a session | *"What should I do after session BRK155?"* |
3546

36-
The skill pulls session data from the **live Build 2026 catalog** — no stale data, no manual updates. For SDK docs and code samples, it uses the **Microsoft Learn MCP Server**.
47+
### After Build — ship what you learned
3748

38-
If you have **Node.js 22+** installed, the skill automatically uses the `@microsoft/events-cli` for faster local search and caching. Without Node.js, it falls back to direct HTTP — everything still works.
49+
| Ask the skill to… | Example |
50+
|------------------------------------------|-------------------------------------------------------|
51+
| Scaffold a project from a session | *"Scaffold a project from session BRK155"* |
52+
| See what changed for your project | *"What changed at Build for my project?"* |
3953

40-
Session results are a starting point — for broad topics, ask the agent to refine ("show me more Foundry sessions about observability") or browse the full catalog at [build.microsoft.com/sessions](https://build.microsoft.com/sessions).
54+
## How It Works
4155

42-
## Contributing
56+
The skill is a thin layer over the **live Build 2026 catalog API** — no stale data, no manual updates. For SDK docs and code samples, it falls back to the [Microsoft Learn MCP Server](https://learn.microsoft.com/training/support/mcp).
57+
58+
Session results are a starting point. For broad topics, ask the agent to refine (*"show me more Foundry sessions about observability"*) or browse the full catalog at [build.microsoft.com/sessions](https://build.microsoft.com/sessions).
4359

44-
This project welcomes contributions and suggestions. Most contributions require you to agree to a
45-
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
46-
the rights to use your contribution. For details, visit [Contributor License Agreements](https://cla.opensource.microsoft.com).
60+
## Scope and Limitations
4761

48-
When you submit a pull request, a CLA bot will automatically determine whether you need to provide
49-
a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
50-
provided by the bot. You will only need to do this once across all repos using our CLA.
62+
- **Event-scoped:** Targets Build 2026, with Build 2025 and Ignite 2025 also available. The architecture supports any event that uses the same catalog endpoints.
63+
- **Dependency-driven:** Recommendations are only as good as the dependency files in your project root. If your project doesn't have a manifest file, tell the skill your stack directly.
64+
- **Not offline:** Requires network access to query the catalog and Learn MCP server.
65+
66+
## Contributing
5167

52-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
53-
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
54-
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
68+
See [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to this project.
5569

5670
## Trademarks
5771

0 commit comments

Comments
 (0)