Skip to content

Commit 91125bb

Browse files
mconstantinescumacko76Copilot
authored
docs(readme): add generic install paths and devcontainer guidance (#54)
* chore(devcontainer): add podman-friendly devcontainer setup * docs(readme): add three install paths and prerequisites * docs(readme): normalize table formatting * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * fix(devcontainer): use typescript-node 22-bookworm base image --------- Co-authored-by: macko76 <c_marius@msn.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent 81ca024 commit 91125bb

3 files changed

Lines changed: 115 additions & 31 deletions

File tree

.devcontainer/Dockerfile

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
FROM mcr.microsoft.com/devcontainers/typescript-node:22-bookworm
2+
3+
# Keep image lean and deterministic for both Docker and Podman engines.
4+
RUN apt-get update \
5+
&& export DEBIAN_FRONTEND=noninteractive \
6+
&& apt-get -y install --no-install-recommends \
7+
ca-certificates \
8+
&& apt-get clean \
9+
&& rm -rf /var/lib/apt/lists/*
10+
11+
# Install Playwright system dependencies for E2E tests
12+
RUN npx -y playwright@1.60.0 install-deps

.devcontainer/devcontainer.json

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
{
2+
"name": "ai-engineering-coach",
3+
"build": {
4+
"dockerfile": "Dockerfile",
5+
"context": ".."
6+
},
7+
"remoteUser": "node",
8+
"postCreateCommand": "npm ci",
9+
"customizations": {
10+
"vscode": {
11+
"extensions": [
12+
"dbaeumer.vscode-eslint",
13+
"streetsidesoftware.code-spell-checker",
14+
"ms-playwright.playwright"
15+
],
16+
"settings": {
17+
"npm.packageManager": "npm",
18+
"typescript.tsdk": "node_modules/typescript/lib"
19+
}
20+
}
21+
}
22+
}

README.md

Lines changed: 81 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -50,16 +50,21 @@ AI Engineer Coach reads your local AI session logs and turns them into actionabl
5050

5151
---
5252

53-
## Quick Start
53+
## Installation
5454

55-
```bash
56-
git clone https://github.com/microsoft/ai-engineering-coach.git
57-
cd ai-engineering-coach
58-
npm install
59-
npm run package
60-
```
55+
Choose one of these paths.
56+
57+
### Path 1 -- Prebuilt VSIX (easiest)
58+
59+
Prerequisites:
60+
61+
- VS Code
62+
- Access to the repository Releases page
63+
64+
Steps:
6165

62-
Then install the `.vsix`:
66+
1. Download the latest `ai-engineer-coach-*.vsix` from Releases.
67+
2. Install it in VS Code:
6368

6469
**macOS / Linux**
6570

@@ -73,6 +78,51 @@ code --install-extension ai-engineer-coach-*.vsix
7378
code --install-extension (Get-ChildItem . -Filter 'ai-engineer-coach-*.vsix' | Select-Object -First 1).FullName
7479
```
7580

81+
### Path 2 -- Dev Container build (no local Node.js/npm)
82+
83+
Prerequisites:
84+
85+
- VS Code
86+
- Dev Containers extension
87+
- Docker or Podman
88+
89+
Steps:
90+
91+
1. Clone the repo and open it in VS Code.
92+
2. Reopen in container.
93+
3. Run:
94+
95+
```bash
96+
npm ci
97+
npm run package
98+
```
99+
100+
4. Install the generated `.vsix` using one of the commands above.
101+
102+
### Path 3 -- Local build
103+
104+
Prerequisites:
105+
106+
- VS Code
107+
- Node.js and npm
108+
109+
Steps:
110+
111+
```bash
112+
git clone https://github.com/microsoft/ai-engineering-coach.git
113+
cd ai-engineering-coach
114+
npm ci
115+
npm run package
116+
```
117+
118+
Then install the generated `.vsix` using one of the commands above.
119+
120+
### Release permissions and contribution path
121+
122+
If you do not have permission to publish a Release artifact, open a PR with your changes and ask a maintainer to publish the `.vsix` in Releases.
123+
124+
After install:
125+
76126
1. Open the command palette (`Cmd+Shift+P` / `Ctrl+Shift+P`)
77127
2. Run **AI Engineer Coach: Open Dashboard**
78128
3. Navigate pages from the sidebar, filter by workspace or harness
@@ -83,39 +133,39 @@ code --install-extension (Get-ChildItem . -Filter 'ai-engineer-coach-*.vsix' | S
83133

84134
### Observe
85135

86-
| Page | Description |
87-
|------|-------------|
88-
| **Dashboard** | Practice scores with week-over-week trends, daily activity chart, top workspace stats |
89-
| **Timeline** | Gantt-style session timeline with per-day drill-down and overlap detection |
90-
| **Coding Moments** | Screenshot gallery from AI coding sessions with story reels and workspace filtering |
136+
| Page | Description |
137+
| ------------------ | ------------------------------------------------------------------------------------- |
138+
| **Dashboard** | Practice scores with week-over-week trends, daily activity chart, top workspace stats |
139+
| **Timeline** | Gantt-style session timeline with per-day drill-down and overlap detection |
140+
| **Coding Moments** | Screenshot gallery from AI coding sessions with story reels and workspace filtering |
91141

92142
### Measure
93143

94-
| Page | Description |
95-
|------|-------------|
96-
| **Output** | Generated code volume by language, model usage table *(token breakdown temporarily hidden)* |
97-
| **Burndown** | Monthly AI token budget progress with projections *(temporarily disabled)* |
98-
| **Patterns** | 7×24 activity heatmap and work-life balance signals |
144+
| Page | Description |
145+
| ------------ | ------------------------------------------------------------------------------------------- |
146+
| **Output** | Generated code volume by language, model usage table _(token breakdown temporarily hidden)_ |
147+
| **Burndown** | Monthly AI token budget progress with projections _(temporarily disabled)_ |
148+
| **Patterns** | 7×24 activity heatmap and work-life balance signals |
99149

100150
### Improve
101151

102-
| Page | Description |
103-
|------|-------------|
104-
| **Anti-Patterns** | Five practice score cards with severity ratings, concrete actions, and example prompts. 45 editable markdown rules plus a coverage heatmap |
105-
| **Rule Editor** | Create, edit, and tune detection rules visually or as raw markdown. Live-test against your data |
106-
| **Rule Playground** | Interactive REPL for the rule DSL with field browser, function catalog, and metric list |
107-
| **Data Explorer** | Browse session fields, view distributions, run ad-hoc filters |
108-
| **Skill Finder** | Discover repeated prompt patterns and matching community skills from the open-source catalog |
109-
| **Context Health** | Overall context score, agentic readiness checklist, workspace context map, AI-powered instruction-file review |
152+
| Page | Description |
153+
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
154+
| **Anti-Patterns** | Five practice score cards with severity ratings, concrete actions, and example prompts. 45 editable markdown rules plus a coverage heatmap |
155+
| **Rule Editor** | Create, edit, and tune detection rules visually or as raw markdown. Live-test against your data |
156+
| **Rule Playground** | Interactive REPL for the rule DSL with field browser, function catalog, and metric list |
157+
| **Data Explorer** | Browse session fields, view distributions, run ad-hoc filters |
158+
| **Skill Finder** | Discover repeated prompt patterns and matching community skills from the open-source catalog |
159+
| **Context Health** | Overall context score, agentic readiness checklist, workspace context map, AI-powered instruction-file review |
110160

111161
### Level Up
112162

113-
| Page | Description |
114-
|------|-------------|
163+
| Page | Description |
164+
| ------------------- | -------------------------------------------------------------------------------- |
115165
| **Learning Center** | Personalized quizzes and code-comparison rounds generated from your actual usage |
116-
| **Achievements** | XP-based progression with Bronze → Silver → Gold → Diamond tiers |
117-
| **Agentic SDLC** | How you use AI across the full software-development lifecycle |
118-
| **Share** | Generate a shareable stat card and export Markdown/JSON summaries |
166+
| **Achievements** | XP-based progression with Bronze → Silver → Gold → Diamond tiers |
167+
| **Agentic SDLC** | How you use AI across the full software-development lifecycle |
168+
| **Share** | Generate a shareable stat card and export Markdown/JSON summaries |
119169

120170
---
121171

0 commit comments

Comments
 (0)