You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-10Lines changed: 9 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,21 +26,20 @@
26
26
27
27
> [!NOTE]
28
28
> **📋 Prerequisites**: Get tokens at [github.com/settings/personal-access-tokens/new](https://github.com/settings/personal-access-tokens/new)
29
-
> -**`GITHUB_APM_PAT`** - Fine-grained PAT for access to private APM modules (optional, recommended)
30
-
> -**`GITHUB_TOKEN`** - User-scoped fine-grained PAT with read Models scope for GitHub Models API (optional, enables free GitHub Models access with Codex CLI and llm)
29
+
> -**`GITHUB_COPILOT_PAT`** - User-scoped Fine-grained PAT with Copilot CLI subscription access
30
+
> -**`GITHUB_APM_PAT`** - (optional) - Fine-grained PAT for access to private APM modules
Copy file name to clipboardExpand all lines: docs/getting-started.md
+9-5Lines changed: 9 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,10 +8,6 @@ Welcome to APM - the AI Package Manager that transforms any project into reliabl
8
8
9
9
APM requires GitHub tokens for accessing models and package registries. Get your tokens at [github.com/settings/personal-access-tokens/new](https://github.com/settings/personal-access-tokens/new):
10
10
11
-
### GitHub Tokens Required
12
-
13
-
APM requires GitHub tokens for accessing models and package registries. Get your tokens at [github.com/settings/personal-access-tokens/new](https://github.com/settings/personal-access-tokens/new):
14
-
15
11
#### Required Tokens
16
12
17
13
##### GITHUB_APM_PAT (Fine-grained PAT - Recommended)
@@ -178,7 +174,15 @@ This creates a platform-specific binary at `./dist/apm-{platform}-{arch}/apm` th
178
174
179
175
APM works with multiple AI coding agents. Choose your preferred runtime:
180
176
181
-
### OpenAI Codex CLI (Recommended)
177
+
### GitHub Copilot CLI (Recommended)
178
+
179
+
```bash
180
+
apm runtime setup copilot
181
+
```
182
+
183
+
Uses GitHub Copilot CLI with native MCP integration and advanced AI coding assistance.
APM automatically installs GitHub Copilot CLI from the public npm registry. Copilot CLI provides advanced AI coding assistance with native MCP integration and GitHub context awareness.
37
+
38
+
### Setup
39
+
40
+
#### 1. Install via APM
41
+
```bash
42
+
apm runtime setup copilot
43
+
```
44
+
45
+
This automatically:
46
+
- Installs GitHub Copilot CLI from public npm registry
47
+
- Requires Node.js v22+ and npm v10+
48
+
- Creates MCP configuration directory at `~/.copilot/`
49
+
- No authentication required for installation
50
+
51
+
### Usage
52
+
53
+
APM executes scripts defined in your `apm.yml`. When scripts reference `.prompt.md` files, APM compiles them with parameter substitution. See [Prompts Guide](prompts.md) for details.
APM executes scripts defined in your `apm.yml`. When scripts reference `.prompt.md` files, APM compiles them with parameter substitution. See [Prompts Guide](prompts.md) for details.
61
-
62
93
```bash
63
94
# Run scripts (from apm.yml) with parameters
64
95
apm run start --param service_name=api-gateway
@@ -122,15 +153,23 @@ scripts:
122
153
```bash
123
154
# Run scripts defined in apm.yml
124
155
apm run start --param service_name=api-gateway
125
-
apm run llm --param service_name=api-gateway
156
+
apm run copilot-analysis --param service_name=api-gateway
126
157
apm run debug --param service_name=api-gateway
127
158
```
128
159
129
-
### Code Analysis
160
+
### Code Analysis with Copilot CLI
130
161
```bash
131
-
# Scripts that use Codex for code understanding
162
+
# Scripts that use Copilot CLI for advanced code understanding
132
163
apm run code-review --param pull_request=123
133
164
apm run analyze-code --param file_path="src/main.py"
165
+
apm run refactor --param component="UserService"
166
+
```
167
+
168
+
### Code Analysis with Codex
169
+
```bash
170
+
# Scripts that use Codex for code understanding
171
+
apm run codex-review --param pull_request=123
172
+
apm run codex-analyze --param file_path="src/main.py"
134
173
```
135
174
136
175
### Documentation Tasks
@@ -145,17 +184,22 @@ apm run summarize --param report_type="weekly"
0 commit comments