alignfirst 0.1.0-beta.1 → 0.1.0-beta.2
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 +77 -4
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# alignfirst
|
|
2
2
|
|
|
3
|
-
The AlignFirst CLI provides
|
|
3
|
+
The AlignFirst CLI provides collaborative software-development workflows, task files, shared plans, project conventions, documentation discovery, and setup diagnostics.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
4
6
|
|
|
5
7
|
Install it globally:
|
|
6
8
|
|
|
@@ -11,10 +13,26 @@ npm install -g alignfirst
|
|
|
11
13
|
Or run the current version without installing it:
|
|
12
14
|
|
|
13
15
|
```sh
|
|
14
|
-
npx
|
|
16
|
+
npx alignfirst
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Setup with your agent
|
|
20
|
+
|
|
21
|
+
Temporarily install the setup-guide skill:
|
|
22
|
+
|
|
23
|
+
```sh
|
|
24
|
+
npx skills add https://github.com/paleo/alignfirst --skill alignfirst-setup-guide
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Then ask your agent:
|
|
28
|
+
|
|
29
|
+
```text
|
|
30
|
+
Use your alignfirst-setup-guide skill. Set up AlignFirst in this project. Ask before installing anything globally.
|
|
15
31
|
```
|
|
16
32
|
|
|
17
|
-
|
|
33
|
+
The guide installs the selected components and configures the repository. Remove the setup-guide skill when setup is complete.
|
|
34
|
+
|
|
35
|
+
## Commands
|
|
18
36
|
|
|
19
37
|
- `guide` — Print an AlignFirst protocol.
|
|
20
38
|
- `ticket` — Resolve a ticket directory and its next file.
|
|
@@ -28,4 +46,59 @@ Commands:
|
|
|
28
46
|
|
|
29
47
|
Run `alignfirst --help` for command usage or `alignfirst guide` for the collaboration guide.
|
|
30
48
|
|
|
31
|
-
|
|
49
|
+
## Agent skills
|
|
50
|
+
|
|
51
|
+
Eight optional Agent Skill stubs expose the CLI to GitHub Copilot, Cursor, Claude Code, and Codex. The skills contain no protocols; they invoke `npx alignfirst guide`.
|
|
52
|
+
|
|
53
|
+
Install them globally:
|
|
54
|
+
|
|
55
|
+
```sh
|
|
56
|
+
npx skills add https://github.com/paleo/alignfirst --global \
|
|
57
|
+
--skill alignfirst --skill al --skill alplan --skill alspec \
|
|
58
|
+
--skill aldescription --skill alreview --skill alcatchup --skill almerge
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Restart the agent after installation. Claude Code, GitHub Copilot, and Cursor expose skills with `/`; Codex uses `$`.
|
|
62
|
+
|
|
63
|
+
## Workflows
|
|
64
|
+
|
|
65
|
+
These examples use the `/` form. Replace it with `$` in Codex.
|
|
66
|
+
|
|
67
|
+
| Workflow | Command | Result |
|
|
68
|
+
| --- | --- | --- |
|
|
69
|
+
| Specification | `/alspec <request>` | Discuss and write a technical specification. |
|
|
70
|
+
| Planning | `/alplan` | Turn a specification into one or more implementation plans. |
|
|
71
|
+
| Align and do | `/al <request>` | Discuss and implement a small change, then write a summary. |
|
|
72
|
+
| Description | `/aldescription` | Summarize the work and propose a commit message. |
|
|
73
|
+
| Review | `/alreview` | Review the current branch against its base. |
|
|
74
|
+
| Merge | `/almerge` | Resolve merge or rebase conflicts. |
|
|
75
|
+
| Catch up | `/alcatchup` | Load the current task history and continue. |
|
|
76
|
+
|
|
77
|
+
To implement a plan, start a fresh agent context and ask it to execute the plan file.
|
|
78
|
+
|
|
79
|
+
AlignFirst stores specifications, plans, and summaries in `.plans/<ticket-id>/`. It normally derives the ticket ID from the request or branch and asks when none is available. Files use a cycle letter and sequence number, such as `A1-spec.md` and `A2-plan.md`.
|
|
80
|
+
|
|
81
|
+
## Updates
|
|
82
|
+
|
|
83
|
+
```sh
|
|
84
|
+
npm update -g alignfirst
|
|
85
|
+
npx skills update --global --yes
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Upgrade from v1, v2, or v3
|
|
89
|
+
|
|
90
|
+
Install the setup-guide skill and ask your agent to run its upgrade route:
|
|
91
|
+
|
|
92
|
+
```sh
|
|
93
|
+
npx skills add https://github.com/paleo/alignfirst --skill alignfirst-setup-guide
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
```text
|
|
97
|
+
Use your alignfirst-setup-guide skill. Upgrade AlignFirst in this project.
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
_Note: the setup-guide skill can be removed safely after it's done._
|
|
101
|
+
|
|
102
|
+
## License
|
|
103
|
+
|
|
104
|
+
CC0 1.0 Universal.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "alignfirst",
|
|
3
|
-
"version": "0.1.0-beta.
|
|
3
|
+
"version": "0.1.0-beta.2",
|
|
4
4
|
"license": "CC0-1.0",
|
|
5
5
|
"author": "Thomas MUR",
|
|
6
6
|
"description": "The AlignFirst CLI: protocols, plans and docs in one command.",
|
|
@@ -34,7 +34,7 @@
|
|
|
34
34
|
"access": "public"
|
|
35
35
|
},
|
|
36
36
|
"dependencies": {
|
|
37
|
-
"@paleo/docmap": "~0.
|
|
37
|
+
"@paleo/docmap": "~0.10.0-beta.0",
|
|
38
38
|
"arktype": "^2.2.3",
|
|
39
39
|
"semver": "^7.8.5"
|
|
40
40
|
},
|