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
chore: update version to 2.0.3 and modify descriptions in package files
- Bump version from 2.0.1 to 2.0.3 in package.json and package-lock.json
- Update description in package.json for clarity on functionality
- Remove outdated plan.md file and create a new publication plan document
- Adjust Content Security Policy in cockpitWebviewDocument.ts for improved security
- Revise localized strings in cockpitWebviewStrings.ts for better accuracy and clarity
- Update i18n messages for consistency with new functionality and terminology
Copy file name to clipboardExpand all lines: README.md
+37-25Lines changed: 37 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,19 +18,21 @@
18
18
19
19
<!-- markdownlint-enable MD033 MD041 -->
20
20
21
-
Copilot Cockpit helps you plan AI work, approve it, and then run it with visible checkpoints instead of handing your repo to a blind autonomous loop.
21
+
Copilot Cockpit is one workflow system for AI work in VS Code: planning and triage, execution and scheduling, and optional tool/control-plane integration.
22
22
23
23
## Why It Exists
24
24
25
-
Most AI automation demos jump straight to execution. That looks impressive until the model burns tokens, edits files too early, or drifts away from the real goal.
25
+
Most AI tooling still reads like feature accumulation: a todo board here, a scheduler there, a tool bridge somewhere else. Copilot Cockpit is meant to feel like one coherent stack.
26
26
27
-
Copilot Cockpit separates planning, approval, execution, and review so autonomy is earned step by step instead of assumed from the start.
27
+
It connects three tightly linked layers:
28
28
29
-
In practice, the LLM is the native execution chat surface, while Copilot Cockpit is the orchestration and review layer around it. It gives a human or AI decision-maker a place to capture work, review it, research it, discuss it, and hand it off safely.
29
+
1. Planning and triage in `Todo Cockpit`
30
+
2. Execution and scheduling through `Tasks` and `Jobs`
31
+
3. Tool and control-plane integration through `Research`, `MCP`, and optional agent surfaces
30
32
31
-
The point is not to reject automation. The point is to make automation accountable and keep humans in charge until the workflow has proven it deserves more autonomy.
33
+
The workflow is explicit on purpose. A `Todo` is the planning artifact. A `Task` is one executable unit. A `Job` is an orchestrated or scheduled run built from steps. `Research` is an exploratory context-building artifact when the system still needs evidence before execution.
32
34
33
-
That matters most when the repo keeps producing more work than any one person can hold in memory: bugs, feature ideas, follow-up changes, security updates, web findings, pricing checks, customer tasks, or research that should turn into implementation later. Copilot Cockpit turns those discoveries into a visible queue so work can be found again and handled properly instead of getting lost between chat sessions.
35
+
That structure keeps the LLM as the native execution chat surface while Copilot Cockpit provides the approval, scheduling, and control layer around it. The goal is not less automation. The goal is accountable automation that can move from intake to execution without losing review, context, or ownership.
34
36
35
37
## 🎬 Demo
36
38
@@ -42,15 +44,15 @@ For the step-by-step walkthrough, open [docs/feature-tour.md](docs/feature-tour.
42
44
43
45
## 🧠 The Core Loop
44
46
45
-
Think of Copilot Cockpit as a local control system for structured AI work:
47
+
The recommended default path is simple:
46
48
47
-
1.Capture and discuss work in `Todo Cockpit`.
48
-
2. Research and refine it until the user is happy with the direction.
49
-
3.Move approved work into `ready`.
50
-
4.Turn that work into a `Task`, `Job`, or `Research` run.
51
-
5.Review outcomes before granting more autonomy.
49
+
1.Start with a `Todo` in `Todo Cockpit` for intake, planning, and triage.
50
+
2.Use `Research` only when context is missing or the direction still needs evidence.
51
+
3.Promote approved work into a `Task` for one executable unit or a `Job` for an orchestrated run.
52
+
4.Review the result before granting more autonomy or scheduling the next cycle.
53
+
5.Add `MCP`, repo-local skills, or agent/control-plane features only when the core loop is already working.
52
54
53
-
This keeps the relationship collaborative: you work with the LLM, not under a black-box agent that guesses what should happen next.
55
+
This keeps the relationship collaborative: the workflow starts with planning, earns execution, and only then extends into higher-autonomy integrations.
54
56
55
57
## Built On VS Code And GitHub Copilot
56
58
@@ -95,29 +97,37 @@ The optional layer stays practical because responsibilities are split deliberate
95
97
96
98
Bundled-agent sync is manual by design. Repo-local agent systems are user-owned, so Copilot Cockpit only offers the starter pack as an optional baseline and does not overwrite customized workspace copies during sync. For the deeper operating model, see [docs/agent-workflow.md](docs/agent-workflow.md).
97
99
98
-
## ✨ Feature Tour
100
+
## ✨ Workflow Layers
101
+
102
+
### Stable workflow primitives
103
+
104
+
These are the default path and the main product surface.
99
105
100
106
### Todo Cockpit
101
107
102
-
`Todo Cockpit` is the planning and approval hub. Use it to capture work, add comments, apply labels and flags, and hand approved work into execution.
108
+
`Todo Cockpit` is the planning and triage layer. A `Todo` stays a planning artifact: capture work, add comments, apply labels and workflow flags, and decide what should happen next.
103
109
104
110
### Tasks
105
111
106
-
`Tasks` are the simplest execution unit: one prompt, one scheduled action, one concrete piece of work. Use them for one-time runs or recurring execution.
112
+
`Tasks` are the simplest execution layer artifact: one executable unit, one prompt, one scheduled action, one concrete piece of work. Use them for one-time runs or recurring execution.
107
113
108
114
That includes recurring tasks such as security research, market checks, feature scouting, maintenance prompts, prompt refinement, repo upkeep, or any other repeated work that should run on a schedule and return to review.
109
115
110
116
### Jobs
111
117
112
-
`Jobs` are ordered multi-step workflows built from multiple steps with reusable actions and pause checkpoints. Use them when the work should not run as one uninterrupted chain.
118
+
`Jobs` are the orchestration layer inside execution: ordered multi-step workflows with reusable actions and pause checkpoints. Use them when work should not run as one uninterrupted chain.
113
119
114
120
Think of `Jobs` as deeper agentic workflows inside VS Code: research, decision support, implementation steps, maintenance steps, MCP calls, or external-tool sequences that should be inspected at explicit checkpoints instead of left to one opaque run.
115
121
116
122
### Research
117
123
118
-
`Research` profiles are bounded benchmark-driven iteration loops. Use them when you need repeated attempts at improvement against a metric instead of one direct execution.
124
+
`Research` is the exploratory context-building layer. Use it when the system is missing context, needs outside evidence, or should iterate against a benchmark before you decide on execution.
125
+
126
+
Research is especially useful when work should pull in fresher outside knowledge first, through web search, Perplexity, scrapers, or other tooling, and then return that material for user review before implementation begins.
119
127
120
-
Research is especially useful when the work should pull in fresher outside knowledge first, through web search, Perplexity, scrapers, or other tooling, and then return that material for user review before implementation begins.
128
+
### Experimental and advanced playground capabilities
129
+
130
+
These capabilities stay discoverable, but they are not required for the default path.
121
131
122
132
### Model And Agent Choice
123
133
@@ -127,11 +137,11 @@ That also creates a control layer for cost: GitHub Copilot or OpenRouter can use
127
137
128
138
### Settings
129
139
130
-
`Settings` configure workspace defaults, integrations, storage mode, and execution preferences so the cockpit matches the repo you are operating in. They are also where you can optionally incorporate repo-local agents or the bundled starter pack when you want an orchestration layer that lets the CEO or orchestrator stay focused on routing, planning, and validation while specialists handle bounded work. See [docs/agent-workflow.md](docs/agent-workflow.md) for the operating model.
140
+
`Settings` configure workspace defaults, integrations, storage mode, and execution preferences so the cockpit matches the repo you are operating in. They are also where you can optionally incorporate repo-local agents or the bundled starter pack when you want an extra control-plane layer that lets the orchestrator stay focused on routing, planning, and validation while specialists handle bounded work. See [docs/agent-workflow.md](docs/agent-workflow.md) for the operating model.
131
141
132
142
### How To Use
133
143
134
-
`How To Use` is the built-in onboarding tab. Start there if you want a guided explanation of the operating model before you schedule anything. You can also launch the same walkthrough from the top bar with `Intro Tutorial`, then use the top-bar `Plan Integration` button to inspect existing repo-local agent surfaces before you approve any manual bundled-agent sync. That optional agent layer is useful when you want the orchestrator to receive the task, do the initial repo framing, delegate bounded work to the right repo-local or starter-pack specialist, and then validate the returned result instead of carrying the full implementation loop in one long chat.
144
+
`How To Use` is the built-in onboarding tab. Start there if you want the recommended path explained in order: `Todo` first, `Research` when context is missing, `Task` or `Job` for execution, then optional control-plane integration after the core loop is working.
135
145
136
146
## Common Workflows
137
147
@@ -189,10 +199,10 @@ The point is not to overclaim autonomy. The point is to show recurring, inspecta
189
199
190
200
1. Open Copilot Cockpit from the activity bar or run `Copilot Cockpit: Create Scheduled Prompt (GUI)` from the command palette. Or use the todo-list icon in the top right.
191
201
2. Start in `How To Use` if you are new to the extension, or click the top-bar `Intro Tutorial` button for the same guided walkthrough.
192
-
3. Capture or refine work in `Todo Cockpit`.
193
-
4.Move approved work into `ready` to prepare a task draft.
194
-
5.Use `Tasks` for one execution unit, `Jobs` for multi-step flows, and `Research` for benchmark-driven iteration.
195
-
6. Open `Settings` to configure repo-local defaults, MCP, Copilot skills, and Codex support files.
202
+
3. Capture or refine work in `Todo Cockpit` until the planning artifact is clear.
203
+
4.Use `Research` if the work still needs exploratory context or outside evidence.
204
+
5.Move approved work into `ready`, then promote it into a `Task` for one executable unit or a `Job` for an orchestrated run.
205
+
6. Open `Settings` to configure repo-local defaults. Add `MCP`, Copilot skills, starter agents, or other control-plane features only when you want those optional extensions.
196
206
197
207
The `Settings` tab also lets you manually sync bundled starter agents into `.github/agents` when you want that optional specialist layer. This is useful when the orchestrator should hand work to the right specialist instead of stuffing planning, execution, and review into one long chat. Treat any existing repo-local agent setup as user-owned first. Only approve a sync when you want it, back up `.github` first when it already exists, and keep in mind that customized workspace copies are skipped so your repo-specific agent edits are not overwritten.
198
208
@@ -219,6 +229,8 @@ Detailed documentation lives under [docs/index.md](docs/index.md).
219
229
220
230
## Advanced Capabilities
221
231
232
+
These extend the core workflow. They are optional and should not be mandatory for onboarding.
233
+
222
234
-`MCP` gives AI agents a controlled tool surface to use the plugin inside the workspace.
223
235
- Support for Copilot-first workflows, with experimental Codex integration for repo-local coordination.
224
236
- Bundled starter agents can be synced into `.github/agents` as a small default orchestration layer: `CEO`, `Planner`, `Remediation Implementer`, `Documentation Specialist`, `Custom Agent Foundry`, and `Cockpit Todo Expert`. The pattern is optional, keeps the top-level orchestrator cleaner, and is described in [docs/agent-workflow.md](docs/agent-workflow.md).
Copy file name to clipboardExpand all lines: docs/getting-started.md
+21-15Lines changed: 21 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,27 +1,33 @@
1
1
# Getting Started
2
2
3
-
Copilot Cockpit works best when you think of it as a simple loop:
3
+
Copilot Cockpit works best when you treat it as one workflow stack with three layers:
4
4
5
-
1. Plan the work.
6
-
2. Approve the handoff.
7
-
3. Run the right execution unit.
8
-
4. Review the result before granting more autonomy.
5
+
1. Planning and triage in `Todo Cockpit`
6
+
2. Execution and scheduling through `Tasks` and `Jobs`
7
+
3. Optional tool/control-plane integration through `Research`, `MCP`, and repo-local agent surfaces
8
+
9
+
The recommended path is: start with a `Todo`, use `Research` when context is missing, then promote approved work into a `Task` or `Job`.
9
10
10
11
## Quick Start
11
12
12
13
1. Open Copilot Cockpit from the activity bar or with `Copilot Cockpit: Create Scheduled Prompt (GUI)`.
13
14
2. Start in `How To Use` if you are new to the extension, or click the top-bar `Intro Tutorial` button for the same walkthrough.
14
-
3. Capture or refine work in `Todo Cockpit`.
15
-
4. Move approved work into a task draft when the item is `ready`.
16
-
5. Use `Tasks` for one execution unit, `Jobs` for ordered multi-step execution, and `Research` for benchmark-driven iteration.
17
-
6. Open `Settings` to configure repo-local defaults and integrations, and use the top-bar `Plan Integration` button when you are ready to inspect or design the repo-local agent setup.
15
+
3. Capture or refine work in `Todo Cockpit`. A `Todo` is the planning artifact and intake surface.
16
+
4. Use `Research` if the work still needs exploratory context, outside evidence, or benchmarked iteration.
17
+
5. Move approved work into `ready`, then promote it into a `Task` for one executable unit or a `Job` for an orchestrated or scheduled run.
18
+
6. Open `Settings` to configure repo-local defaults and integrations. Use the top-bar `Plan Integration` button only when you want optional control-plane extensions such as MCP, skills, or starter agents.
19
+
20
+
## Stable Primitives
21
+
22
+
- Use `Todo Cockpit` when the work still needs planning, comments, approval, or triage.
23
+
- Use `Tasks` when one prompt and one schedule are enough for one executable unit.
24
+
- Use `Jobs` when the work needs ordered stages, orchestration, or pause checkpoints.
25
+
- Use `Research` when the work needs exploratory context or measured improvement before execution.
18
26
19
-
## Choose The Right Surface
27
+
## Optional Extensions
20
28
21
-
- Use `Todo Cockpit` when the work still needs planning, comments, or approval.
22
-
- Use `Tasks` when one prompt and one schedule are enough.
23
-
- Use `Jobs` when the work needs ordered stages or pause checkpoints.
24
-
- Use `Research` when the goal is measured improvement against a benchmark.
29
+
- Add `MCP`, repo-local skills, or starter agents after the default path is working.
30
+
- Treat those capabilities as control-plane extensions, not as mandatory setup for first use.
25
31
26
32
If you want the tab-by-tab walkthrough, continue to [Feature Tour](./feature-tour.md).
27
33
@@ -31,7 +37,7 @@ Skip toy prompts. Start with one recurring loop that would still be worth keepin
31
37
32
38
- For a small project, use an opportunity scout, a delivery-risk watch, and a knowledge packager, then stop at a review checkpoint.
33
39
- For a company team, use the same pattern for product signals, security and release readiness, support queues, or operations follow-up.
34
-
- If you also want to show the Research surface, add one benchmarked profile that scores onboarding or prompt quality against a simple command.
40
+
- If you also want to show the Research surface, add one benchmarked profile that scores onboarding or prompt quality against a simple command before you promote anything into execution.
35
41
36
42
That keeps the demo honest: the proof is useful output plus explicit review, not a claim that the system should run unchecked.
0 commit comments