conductor-install 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -6
- package/dist/conductor/conductor/CHANGELOG.md +39 -0
- package/dist/conductor/conductor/CONTRIBUTING.md +33 -0
- package/dist/conductor/conductor/GEMINI.md +41 -0
- package/dist/conductor/conductor/LICENSE +202 -0
- package/dist/conductor/conductor/README.md +128 -0
- package/dist/conductor/conductor/commands/conductor/implement.toml +179 -0
- package/dist/conductor/conductor/commands/conductor/newTrack.toml +154 -0
- package/dist/conductor/conductor/commands/conductor/revert.toml +130 -0
- package/dist/conductor/conductor/commands/conductor/review.toml +158 -0
- package/dist/conductor/conductor/commands/conductor/setup.toml +456 -0
- package/dist/conductor/conductor/commands/conductor/status.toml +57 -0
- package/dist/conductor/conductor/gemini-extension.json +5 -0
- package/dist/conductor/conductor/release-please-config.json +11 -0
- package/dist/conductor/conductor/templates/code_styleguides/cpp.md +113 -0
- package/dist/conductor/conductor/templates/code_styleguides/csharp.md +115 -0
- package/dist/conductor/conductor/templates/code_styleguides/dart.md +238 -0
- package/dist/conductor/conductor/templates/code_styleguides/general.md +23 -0
- package/dist/conductor/conductor/templates/code_styleguides/go.md +48 -0
- package/dist/conductor/conductor/templates/code_styleguides/html-css.md +49 -0
- package/dist/conductor/conductor/templates/code_styleguides/javascript.md +51 -0
- package/dist/conductor/conductor/templates/code_styleguides/python.md +37 -0
- package/dist/conductor/conductor/templates/code_styleguides/typescript.md +43 -0
- package/dist/conductor/conductor/templates/workflow.md +333 -0
- package/dist/conductor-install.cjs +242 -246
- package/dist/conductor-install.js +241 -245
- package/dist/index.cjs +242 -246
- package/dist/index.js +241 -245
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -6,9 +6,9 @@
|
|
|
6
6
|
|
|
7
7
|
[English](./README.md) | [中文](./README_zh.md) | [日本語](./README_ja.md) | [한국어](./README_ko.md)
|
|
8
8
|
|
|
9
|
-
**Conductor Install** is a standalone command-line tool designed to bring the [Conductor](https://github.com/gemini-cli-extensions/conductor) spec-driven development methodology to *any* coding environment.
|
|
9
|
+
**Conductor Install** is a standalone command-line tool designed to bring the [Conductor](https://github.com/gemini-cli-extensions/conductor) spec-driven development methodology to *any* coding agent environment.
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
The Conductor methodology was originally tied to the Gemini CLI extension. This project decouples it, allowing developers to install and configure Conductor workflows in their projects so they can be leveraged by **any** AI Coding Agent (e.g., Claude Code, Cursor, VS Code Copilot, Codex) or IDE.
|
|
12
12
|
|
|
13
13
|
## 🎯 Goals
|
|
14
14
|
|
|
@@ -20,6 +20,30 @@ Originally tied to the Gemini CLI extension, this project aims to decouple the m
|
|
|
20
20
|
|
|
21
21
|
### 1. Setup Conductor in Your Project
|
|
22
22
|
|
|
23
|
+
```text
|
|
24
|
+
conductor-install [path] [options]
|
|
25
|
+
|
|
26
|
+
Positionals:
|
|
27
|
+
path Directory to install Conductor[string] [default: "."]
|
|
28
|
+
|
|
29
|
+
Options:
|
|
30
|
+
-a, --agent Specify the coding agent
|
|
31
|
+
[string] [choices: "opencode", "claude-code",
|
|
32
|
+
"antigravity", "cursor", "vscode-copilot", "codex",
|
|
33
|
+
"windsurf", "cline", "gemini"]
|
|
34
|
+
-r, --repo Git repository URL for conductor
|
|
35
|
+
[string] [default:
|
|
36
|
+
"https://github.com/gemini-cli-extensions/conductor"]
|
|
37
|
+
-b, --branch Branch name for conductor repository
|
|
38
|
+
[string] [default: "main"]
|
|
39
|
+
-s, --scope Installation scope (project or global)
|
|
40
|
+
[string] [choices: "project", "global"]
|
|
41
|
+
-f, --force Force overwrite existing installation
|
|
42
|
+
[boolean] [default: false]
|
|
43
|
+
-h, --help Show help [boolean]
|
|
44
|
+
-v, --version Show version number [boolean]
|
|
45
|
+
```
|
|
46
|
+
|
|
23
47
|
To initialize Conductor in your project, simply run the following command in your project root:
|
|
24
48
|
|
|
25
49
|
```bash
|
|
@@ -67,10 +91,12 @@ This will verify the environment and install the necessary Conductor files:
|
|
|
67
91
|
|
|
68
92
|
Once installed, you can instruct your AI Agent to perform Conductor tasks using the installed commands. For example:
|
|
69
93
|
|
|
70
|
-
-
|
|
71
|
-
-
|
|
72
|
-
-
|
|
73
|
-
-
|
|
94
|
+
- `/conductor:setup` - Initialize the project structure.
|
|
95
|
+
- `/conductor:newTrack` - Start a new feature or bug fix track.
|
|
96
|
+
- `/conductor:implement` - Implement the selected track.
|
|
97
|
+
- `/conductor:review` - Review the completed track work against guidelines and the plan.
|
|
98
|
+
- `/conductor:revert` - Revert previous work.
|
|
99
|
+
- `/conductor:status` - Check the status of current tracks.
|
|
74
100
|
|
|
75
101
|
*Note: The exact invocation syntax depends on your specific agent's slash command or file context capabilities.*
|
|
76
102
|
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## [0.2.0](https://github.com/gemini-cli-extensions/conductor/compare/conductor-v0.1.1...conductor-v0.2.0) (2026-01-14)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* Add GitHub Actions workflow to package and upload release assets. ([5e0fcb0](https://github.com/gemini-cli-extensions/conductor/commit/5e0fcb0d4d19acfd8f62b08b5f9404a1a4f53f14))
|
|
9
|
+
* Add GitHub Actions workflow to package and upload release assets. ([20858c9](https://github.com/gemini-cli-extensions/conductor/commit/20858c90b48eabb5fe77aefab5a216269cc77c09))
|
|
10
|
+
* **conductor:** implement tracks directory abstraction ([caeb814](https://github.com/gemini-cli-extensions/conductor/commit/caeb8146bec590eda35bc7934b796656804fcf9a))
|
|
11
|
+
* Implement Universal File Resolution Protocol ([fe902f3](https://github.com/gemini-cli-extensions/conductor/commit/fe902f32762630e674f186b742f4ebb778473702))
|
|
12
|
+
* integrate release asset packaging into release-please workflow ([3ef512c](https://github.com/gemini-cli-extensions/conductor/commit/3ef512c3320e7877f1c05ed34433cf28a3111b30))
|
|
13
|
+
* introduce index markdown files and the Universal File Resolution Protocol ([bbb69c9](https://github.com/gemini-cli-extensions/conductor/commit/bbb69c9fa8d4a6b3c225bfb665d565715523fa7d))
|
|
14
|
+
* introduce index.md files for file resolution ([cbd24d2](https://github.com/gemini-cli-extensions/conductor/commit/cbd24d2b086697a3ca6e147e6b0edfedb84f99ce))
|
|
15
|
+
* **styleguide:** Add comprehensive Google C# Style Guide summary ([6672f4e](https://github.com/gemini-cli-extensions/conductor/commit/6672f4ec2d2aa3831b164635a3e4dc0aa6f17679))
|
|
16
|
+
* **styleguide:** Add comprehensive Google C# Style Guide summary ([e222aca](https://github.com/gemini-cli-extensions/conductor/commit/e222aca7eb7475c07e618b410444f14090d62715))
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### Bug Fixes
|
|
20
|
+
|
|
21
|
+
* build tarball outside source tree to avoid self-inclusion ([830f584](https://github.com/gemini-cli-extensions/conductor/commit/830f5847c206a9b76d58ebed0c184ff6c0c6e725))
|
|
22
|
+
* **conductor:** ensure track completion and doc sync are committed automatically ([f6a1522](https://github.com/gemini-cli-extensions/conductor/commit/f6a1522d0dea1e0ea887fcd732f1b47475dc0226))
|
|
23
|
+
* **conductor:** ensure track completion and doc sync are committed automatically ([e3630ac](https://github.com/gemini-cli-extensions/conductor/commit/e3630acc146a641f29fdf23f9c28d5d9cdf945b8))
|
|
24
|
+
* **conductor:** remove hardcoded path hints in favor of Universal File Resolution Protocol ([6b14aaa](https://github.com/gemini-cli-extensions/conductor/commit/6b14aaa6f8bffd29b2dc3eb5fc22b2ed1d19418d))
|
|
25
|
+
* Correct typos, step numbering, and documentation errors ([ab9516b](https://github.com/gemini-cli-extensions/conductor/commit/ab9516ba6dd29d0ec5ea40b2cb2abab83fc791be))
|
|
26
|
+
* Correct typos, step numbering, and documentation errors ([d825c32](https://github.com/gemini-cli-extensions/conductor/commit/d825c326061ab63a4d3b8928cbf32bc3f6a9c797))
|
|
27
|
+
* Correct typos, trailing whitespace and grammar ([484d5f3](https://github.com/gemini-cli-extensions/conductor/commit/484d5f3cf7a0c4a8cbbcaff71f74b62c0af3dd35))
|
|
28
|
+
* Correct typos, trailing whitespace and grammar ([94edcbb](https://github.com/gemini-cli-extensions/conductor/commit/94edcbbd0102eb6f9d5977eebf0cc3511aff6f64))
|
|
29
|
+
* Replace manual text input with interactive options ([b49d770](https://github.com/gemini-cli-extensions/conductor/commit/b49d77058ccd5ccedc83c1974cc36a2340b637ab))
|
|
30
|
+
* Replace manual text input with interactive options ([746b2e5](https://github.com/gemini-cli-extensions/conductor/commit/746b2e5f0a5ee9fc49edf8480dad3b8afffe8064))
|
|
31
|
+
* **setup:** clarify definition of 'track' in setup flow ([819dcc9](https://github.com/gemini-cli-extensions/conductor/commit/819dcc989d70d572d81655e0ac0314ede987f8b4))
|
|
32
|
+
* **setup:** Enhance project analysis protocol to avoid excessive token consumption. ([#6](https://github.com/gemini-cli-extensions/conductor/issues/6)) ([1e60e8a](https://github.com/gemini-cli-extensions/conductor/commit/1e60e8a96e5abeab966ff8d5bd95e14e3e331cfa))
|
|
33
|
+
* standardize Markdown checkbox format for tracks and plans ([92080f0](https://github.com/gemini-cli-extensions/conductor/commit/92080f0508ca370373adee1addec07855506adeb))
|
|
34
|
+
* standardize Markdown checkbox format for tracks and plans ([84634e7](https://github.com/gemini-cli-extensions/conductor/commit/84634e774bc37bd3996815dfd6ed41a519b45c1d))
|
|
35
|
+
* **styleguide:** Clarify usage of 'var' in C# guidelines for better readability ([a67b6c0](https://github.com/gemini-cli-extensions/conductor/commit/a67b6c08cac15de54f01cd1e64fff3f99bc55462))
|
|
36
|
+
* **styleguide:** Enhance C# guidelines with additional rules for constants, collections, and argument clarity ([eea7495](https://github.com/gemini-cli-extensions/conductor/commit/eea7495194edb01f6cfa86774cf2981ed012bf73))
|
|
37
|
+
* **styleguide:** Update C# formatting rules and guidelines for consistency ([50f39ab](https://github.com/gemini-cli-extensions/conductor/commit/50f39abf9941ff4786e3b995d4c077bfdf07b9c9))
|
|
38
|
+
* **styleguide:** Update C# guidelines by removing async method suffix rule and adding best practices for structs, collection types, file organization, and namespaces ([8bfc888](https://github.com/gemini-cli-extensions/conductor/commit/8bfc888b1b1a4191228f0d85e3ac89fe25fb9541))
|
|
39
|
+
* **styleguide:** Update C# guidelines for member ordering and enhance clarity on string interpolation ([0e0991b](https://github.com/gemini-cli-extensions/conductor/commit/0e0991b73210f83b2b26007e813603d3cd2f0d48))
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# How to contribute
|
|
2
|
+
|
|
3
|
+
We'd love to accept your patches and contributions to this project.
|
|
4
|
+
|
|
5
|
+
## Before you begin
|
|
6
|
+
|
|
7
|
+
### Sign our Contributor License Agreement
|
|
8
|
+
|
|
9
|
+
Contributions to this project must be accompanied by a
|
|
10
|
+
[Contributor License Agreement](https://cla.developers.google.com/about) (CLA).
|
|
11
|
+
You (or your employer) retain the copyright to your contribution; this simply
|
|
12
|
+
gives us permission to use and redistribute your contributions as part of the
|
|
13
|
+
project.
|
|
14
|
+
|
|
15
|
+
If you or your current employer have already signed the Google CLA (even if it
|
|
16
|
+
was for a different project), you probably don't need to do it again.
|
|
17
|
+
|
|
18
|
+
Visit <https://cla.developers.google.com/> to see your current agreements or to
|
|
19
|
+
sign a new one.
|
|
20
|
+
|
|
21
|
+
### Review our community guidelines
|
|
22
|
+
|
|
23
|
+
This project follows
|
|
24
|
+
[Google's Open Source Community Guidelines](https://opensource.google/conduct/).
|
|
25
|
+
|
|
26
|
+
## Contribution process
|
|
27
|
+
|
|
28
|
+
### Code reviews
|
|
29
|
+
|
|
30
|
+
All submissions, including submissions by project members, require review. We
|
|
31
|
+
use GitHub pull requests for this purpose. Consult
|
|
32
|
+
[GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
|
|
33
|
+
information on using pull requests.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Conductor Context
|
|
2
|
+
|
|
3
|
+
If a user mentions a "plan" or asks about the plan, and they have used the conductor extension in the current session, they are likely referring to the `conductor/tracks.md` file or one of the track plans (`conductor/tracks/<track_id>/plan.md`).
|
|
4
|
+
|
|
5
|
+
## Universal File Resolution Protocol
|
|
6
|
+
|
|
7
|
+
**PROTOCOL: How to locate files.**
|
|
8
|
+
To find a file (e.g., "**Product Definition**") within a specific context (Project Root or a specific Track):
|
|
9
|
+
|
|
10
|
+
1. **Identify Index:** Determine the relevant index file:
|
|
11
|
+
- **Project Context:** `conductor/index.md`
|
|
12
|
+
- **Track Context:**
|
|
13
|
+
a. Resolve and read the **Tracks Registry** (via Project Context).
|
|
14
|
+
b. Find the entry for the specific `<track_id>`.
|
|
15
|
+
c. Follow the link provided in the registry to locate the track's folder. The index file is `<track_folder>/index.md`.
|
|
16
|
+
d. **Fallback:** If the track is not yet registered (e.g., during creation) or the link is broken:
|
|
17
|
+
1. Resolve the **Tracks Directory** (via Project Context).
|
|
18
|
+
2. The index file is `<Tracks Directory>/<track_id>/index.md`.
|
|
19
|
+
|
|
20
|
+
2. **Check Index:** Read the index file and look for a link with a matching or semantically similar label.
|
|
21
|
+
|
|
22
|
+
3. **Resolve Path:** If a link is found, resolve its path **relative to the directory containing the `index.md` file**.
|
|
23
|
+
- *Example:* If `conductor/index.md` links to `./workflow.md`, the full path is `conductor/workflow.md`.
|
|
24
|
+
|
|
25
|
+
4. **Fallback:** If the index file is missing or the link is absent, use the **Default Path** keys below.
|
|
26
|
+
|
|
27
|
+
5. **Verify:** You MUST verify the resolved file actually exists on the disk.
|
|
28
|
+
|
|
29
|
+
**Standard Default Paths (Project):**
|
|
30
|
+
- **Product Definition**: `conductor/product.md`
|
|
31
|
+
- **Tech Stack**: `conductor/tech-stack.md`
|
|
32
|
+
- **Workflow**: `conductor/workflow.md`
|
|
33
|
+
- **Product Guidelines**: `conductor/product-guidelines.md`
|
|
34
|
+
- **Tracks Registry**: `conductor/tracks.md`
|
|
35
|
+
- **Tracks Directory**: `conductor/tracks/`
|
|
36
|
+
|
|
37
|
+
**Standard Default Paths (Track):**
|
|
38
|
+
- **Specification**: `conductor/tracks/<track_id>/spec.md`
|
|
39
|
+
- **Implementation Plan**: `conductor/tracks/<track_id>/plan.md`
|
|
40
|
+
- **Metadata**: `conductor/tracks/<track_id>/metadata.json`
|
|
41
|
+
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# Conductor Extension for Gemini CLI
|
|
2
|
+
|
|
3
|
+
**Measure twice, code once.**
|
|
4
|
+
|
|
5
|
+
Conductor is a Gemini CLI extension that enables **Context-Driven Development**. It turns the Gemini CLI into a proactive project manager that follows a strict protocol to specify, plan, and implement software features and bug fixes.
|
|
6
|
+
|
|
7
|
+
Instead of just writing code, Conductor ensures a consistent, high-quality lifecycle for every task: **Context -> Spec & Plan -> Implement**.
|
|
8
|
+
|
|
9
|
+
The philosophy behind Conductor is simple: control your code. By treating context as a managed artifact alongside your code, you transform your repository into a single source of truth that drives every agent interaction with deep, persistent project awareness.
|
|
10
|
+
|
|
11
|
+
## Features
|
|
12
|
+
|
|
13
|
+
- **Plan before you build**: Create specs and plans that guide the agent for new and existing codebases.
|
|
14
|
+
- **Maintain context**: Ensure AI follows style guides, tech stack choices, and product goals.
|
|
15
|
+
- **Iterate safely**: Review plans before code is written, keeping you firmly in the loop.
|
|
16
|
+
- **Work as a team**: Set project-level context for your product, tech stack, and workflow preferences that become a shared foundation for your team.
|
|
17
|
+
- **Build on existing projects**: Intelligent initialization for both new (Greenfield) and existing (Brownfield) projects.
|
|
18
|
+
- **Smart revert**: A git-aware revert command that understands logical units of work (tracks, phases, tasks) rather than just commit hashes.
|
|
19
|
+
|
|
20
|
+
## Installation
|
|
21
|
+
|
|
22
|
+
Install the Conductor extension by running the following command from your terminal:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
gemini extensions install https://github.com/gemini-cli-extensions/conductor --auto-update
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
The `--auto-update` is optional: if specified, it will update to new versions as they are released.
|
|
29
|
+
|
|
30
|
+
## Usage
|
|
31
|
+
|
|
32
|
+
Conductor is designed to manage the entire lifecycle of your development tasks.
|
|
33
|
+
|
|
34
|
+
**Note on Token Consumption:** Conductor's context-driven approach involves reading and analyzing your project's context, specifications, and plans. This can lead to increased token consumption, especially in larger projects or during extensive planning and implementation phases. You can check the token consumption in the current session by running `/stats model`.
|
|
35
|
+
|
|
36
|
+
### 1. Set Up the Project (Run Once)
|
|
37
|
+
|
|
38
|
+
When you run `/conductor:setup`, Conductor helps you define the core components of your project context. This context is then used for building new components or features by you or anyone on your team.
|
|
39
|
+
|
|
40
|
+
- **Product**: Define project context (e.g. users, product goals, high-level features).
|
|
41
|
+
- **Product guidelines**: Define standards (e.g. prose style, brand messaging, visual identity).
|
|
42
|
+
- **Tech stack**: Configure technical preferences (e.g. language, database, frameworks).
|
|
43
|
+
- **Workflow**: Set team preferences (e.g. TDD, commit strategy). Uses [workflow.md](templates/workflow.md) as a customizable template.
|
|
44
|
+
|
|
45
|
+
**Generated Artifacts:**
|
|
46
|
+
- `conductor/product.md`
|
|
47
|
+
- `conductor/product-guidelines.md`
|
|
48
|
+
- `conductor/tech-stack.md`
|
|
49
|
+
- `conductor/workflow.md`
|
|
50
|
+
- `conductor/code_styleguides/`
|
|
51
|
+
- `conductor/tracks.md`
|
|
52
|
+
|
|
53
|
+
```bash
|
|
54
|
+
/conductor:setup
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### 2. Start a New Track (Feature or Bug)
|
|
58
|
+
|
|
59
|
+
When you’re ready to take on a new feature or bug fix, run `/conductor:newTrack`. This initializes a **track** — a high-level unit of work. Conductor helps you generate two critical artifacts:
|
|
60
|
+
|
|
61
|
+
- **Specs**: The detailed requirements for the specific job. What are we building and why?
|
|
62
|
+
- **Plan**: An actionable to-do list containing phases, tasks, and sub-tasks.
|
|
63
|
+
|
|
64
|
+
**Generated Artifacts:**
|
|
65
|
+
- `conductor/tracks/<track_id>/spec.md`
|
|
66
|
+
- `conductor/tracks/<track_id>/plan.md`
|
|
67
|
+
- `conductor/tracks/<track_id>/metadata.json`
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
/conductor:newTrack
|
|
71
|
+
# OR with a description
|
|
72
|
+
/conductor:newTrack "Add a dark mode toggle to the settings page"
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
### 3. Implement the Track
|
|
76
|
+
|
|
77
|
+
Once you approve the plan, run `/conductor:implement`. Your coding agent then works through the `plan.md` file, checking off tasks as it completes them.
|
|
78
|
+
|
|
79
|
+
**Updated Artifacts:**
|
|
80
|
+
- `conductor/tracks.md` (Status updates)
|
|
81
|
+
- `conductor/tracks/<track_id>/plan.md` (Status updates)
|
|
82
|
+
- Project context files (Synchronized on completion)
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
/conductor:implement
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Conductor will:
|
|
89
|
+
1. Select the next pending task.
|
|
90
|
+
2. Follow the defined workflow (e.g., TDD: Write Test -> Fail -> Implement -> Pass).
|
|
91
|
+
3. Update the status in the plan as it progresses.
|
|
92
|
+
4. **Verify Progress**: Guide you through a manual verification step at the end of each phase to ensure everything works as expected.
|
|
93
|
+
|
|
94
|
+
During implementation, you can also:
|
|
95
|
+
|
|
96
|
+
- **Check status**: Get a high-level overview of your project's progress.
|
|
97
|
+
```bash
|
|
98
|
+
/conductor:status
|
|
99
|
+
```
|
|
100
|
+
- **Revert work**: Undo a feature or a specific task if needed.
|
|
101
|
+
```bash
|
|
102
|
+
/conductor:revert
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
- **Review work**: Review completed work against guidelines and the plan.
|
|
106
|
+
```bash
|
|
107
|
+
/conductor:review
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## Commands Reference
|
|
111
|
+
|
|
112
|
+
| Command | Description | Artifacts |
|
|
113
|
+
| :--- | :--- | :--- |
|
|
114
|
+
| `/conductor:setup` | Scaffolds the project and sets up the Conductor environment. Run this once per project. | `conductor/product.md`<br>`conductor/product-guidelines.md`<br>`conductor/tech-stack.md`<br>`conductor/workflow.md`<br>`conductor/tracks.md` |
|
|
115
|
+
| `/conductor:newTrack` | Starts a new feature or bug track. Generates `spec.md` and `plan.md`. | `conductor/tracks/<id>/spec.md`<br>`conductor/tracks/<id>/plan.md`<br>`conductor/tracks.md` |
|
|
116
|
+
| `/conductor:implement` | Executes the tasks defined in the current track's plan. | `conductor/tracks.md`<br>`conductor/tracks/<id>/plan.md` |
|
|
117
|
+
| `/conductor:status` | Displays the current progress of the tracks file and active tracks. | Reads `conductor/tracks.md` |
|
|
118
|
+
| `/conductor:revert` | Reverts a track, phase, or task by analyzing git history. | Reverts git history |
|
|
119
|
+
| `/conductor:review` | Reviews completed work against guidelines and the plan. | Reads `plan.md`, `product-guidelines.md` |
|
|
120
|
+
|
|
121
|
+
## Resources
|
|
122
|
+
|
|
123
|
+
- [Gemini CLI extensions](https://geminicli.com/docs/extensions/): Documentation about using extensions in Gemini CLI
|
|
124
|
+
- [GitHub issues](https://github.com/gemini-cli-extensions/conductor/issues): Report bugs or request features
|
|
125
|
+
|
|
126
|
+
## Legal
|
|
127
|
+
|
|
128
|
+
- License: [Apache License 2.0](LICENSE)
|