@nerds-with-charisma/revit-ai 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 +105 -16
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,32 +1,107 @@
|
|
|
1
|
-
# @
|
|
1
|
+
# @revit-ai
|
|
2
2
|
|
|
3
|
-
Shared
|
|
3
|
+
Shared Cursor rules, agent definitions, and context templates for any project.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Install this package in a repo, pick the pieces you want, copy them in, then tweak them for that project. This is not an app. It has no UI, no routes, and no database. Just ai helpers that you can pick and choose and control.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
Version: 0.1.0. Requires Node 24 or newer.
|
|
8
|
+
|
|
9
|
+
## Install
|
|
8
10
|
|
|
9
11
|
```bash
|
|
10
|
-
npm install @
|
|
12
|
+
npm install @revit-dev/ai
|
|
11
13
|
# or
|
|
12
|
-
pnpm add @
|
|
14
|
+
pnpm add @revit-dev/ai
|
|
13
15
|
```
|
|
14
16
|
|
|
15
|
-
Then
|
|
17
|
+
Then run the installer:
|
|
16
18
|
|
|
17
19
|
```bash
|
|
18
20
|
npx revit-ai
|
|
19
21
|
```
|
|
20
22
|
|
|
21
|
-
|
|
23
|
+
Choose what you want with spacebar, confirm with enter and let it rock.
|
|
24
|
+
|
|
25
|
+
Where each piece lands:
|
|
26
|
+
|
|
27
|
+
- Agents go to `.ai/agents/`
|
|
28
|
+
- Rules go to `.cursor/rules/`
|
|
29
|
+
- Contexts go to `.documentation/`
|
|
30
|
+
|
|
31
|
+
Template files lose the `.template` part on copy, so `AGENT-CONTEXT.template.md` lands as `AGENT-CONTEXT.md`.
|
|
32
|
+
|
|
33
|
+
### Overwriting
|
|
34
|
+
|
|
35
|
+
The installer never overwrites a file you tweaked. If the destination file is identical, it skips it and says so. If it differs, it skips it, lists it, and says it was tweaked. To overwrite on purpose, run:
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
npx revit-ai --force
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Manual copy
|
|
42
|
+
|
|
43
|
+
The checklist is the standard install. Manual copying still works:
|
|
44
|
+
|
|
45
|
+
- `node_modules/@revit-dev/ai/rules/*.mdc` to your `.cursor/rules/`
|
|
46
|
+
- `node_modules/@revit-dev/ai/agents/*.md` to your `.ai/agents/` (or project equivalent)
|
|
47
|
+
- `node_modules/@revit-dev/ai/contexts/*` to your `.documentation/` (or project equivalent)
|
|
48
|
+
|
|
49
|
+
Tweak em after copying. App-specific edits stay in your repo, not in this package.
|
|
50
|
+
|
|
51
|
+
## What you get
|
|
52
|
+
|
|
53
|
+
### Agents
|
|
54
|
+
|
|
55
|
+
Each agent is one Markdown file, invoked in Cursor with `@name`. Each one does one job, in full sentences, with a verdict first and one next action at the end. No agent rewrites code unless its job says so.
|
|
22
56
|
|
|
23
|
-
|
|
57
|
+
| Agent | Invoke | Job |
|
|
58
|
+
| --------------- | ------------------ | ------------------------------------------------------------------------------------------ |
|
|
59
|
+
| kiss-off | `@kiss-off` | DRY / KISS / reuse crit. Names extracts and deletes, leaves the rest alone. |
|
|
60
|
+
| mentor-me | `@mentor-me` | Teaches and explains a file, an error, or a concept in plain words. |
|
|
61
|
+
| what-the | `@what-the` | Re-pitches the last agent message only, same meaning, easier to read. |
|
|
62
|
+
| spec-builder | `@spec-builder` | Turns a rough ask into a full build spec, in a fixed section order. |
|
|
63
|
+
| pr-runner | `@pr-runner` | Pre-push / pre-PR pass or fail gate. No auto-fix, no raising the PR. |
|
|
64
|
+
| look-over | `@look-over` | Fast pre-commit look-over. 3 to 5 suggestions, no auto-fix, skippable. |
|
|
65
|
+
| test-generator | `@test-generator` | Lists test cases as numbered TCs mapped to requirements. Lists only, does not write tests. |
|
|
66
|
+
| data-guard | `@data-guard` | Checks a claim against the live database or a live file. Flags invented data. |
|
|
67
|
+
| refactor-report | `@refactor-report` | Repo-wide dupe hunt. Top 5 shared-helper candidates, ranked by payoff. |
|
|
68
|
+
| illuminate-me | `@illuminate-me` | One-page repo map, from DB to display. For onboarding and interview prep. |
|
|
69
|
+
| docs-generator | `@docs-generator` | Writes OpenAPI 3.x docs plus a README with fixed sections. Docs only. |
|
|
70
|
+
| task-breaker | `@task-breaker` | Breaks a spec or PRD into tasks. Expands one task, or names what is next. |
|
|
71
|
+
| seo-audit | `@seo-audit` | Scans a codebase or a site and returns one SEO checklist. Scan only, no auto-fix. |
|
|
24
72
|
|
|
25
|
-
-
|
|
26
|
-
- `node_modules/@nerds-with-charisma/revit-ai/contexts/*` → your `.documentation/` (or project equivalent)
|
|
27
|
-
- `node_modules/@nerds-with-charisma/revit-ai/agents/*.md` → your `.ai/agents/` (or project equivalent)
|
|
73
|
+
A dupe in 2 files is kiss-off. A dupe in 3 or more is refactor-report. Pre-commit wants the light eyes-on, that is look-over. Push or PR wants the hard gate, that is pr-runner.
|
|
28
74
|
|
|
29
|
-
|
|
75
|
+
### Rules
|
|
76
|
+
|
|
77
|
+
Rules are `.mdc` files for `.cursor/rules/`. Agents point at these package paths, not at machine-local Cursor rules.
|
|
78
|
+
|
|
79
|
+
| Rule | Job |
|
|
80
|
+
| --------------------- | ----------------------------------------------------------------- |
|
|
81
|
+
| `unslop.mdc` | Voice filter. Plain, sharp, surfer-ey, no AI fluff. |
|
|
82
|
+
| `i-have-adhd.mdc` | Output shape. Lead with the action, numbered steps, short. Focus. |
|
|
83
|
+
| `package-context.mdc` | Reminder that the shared baseline may come from this package. |
|
|
84
|
+
|
|
85
|
+
### Contexts
|
|
86
|
+
|
|
87
|
+
Context templates are copyable skeletons for the consumer repo. Fill in the placeholders after copying.
|
|
88
|
+
|
|
89
|
+
| Template | Lands as | Job |
|
|
90
|
+
| --------------------------- | ----------------------------------------- | -------------------------------------------------------------------- |
|
|
91
|
+
| `AGENT-CONTEXT.template.md` | `.documentation/AGENT-CONTEXT.md` | Where things live in that repo, and how a request flows. |
|
|
92
|
+
| `DECISIONS.template.md` | `.documentation/DECISIONS.md` | Decisions log. One entry per decision: date, choice, why, follow-up. |
|
|
93
|
+
| `spec-template-generic.md` | `.documentation/spec-template-generic.md` | Fixed-section build spec template. Same order spec-builder outputs. |
|
|
94
|
+
|
|
95
|
+
## Quick start
|
|
96
|
+
|
|
97
|
+
1. Install the package and run `npx revit-ai`.
|
|
98
|
+
2. Pick `spec-builder`, `unslop`, `i-have-adhd`, and the three contexts, if that is all you want for now.
|
|
99
|
+
3. Fill in `.documentation/AGENT-CONTEXT.md` for your repo: one sentence on what it is, where things live, how a request flows.
|
|
100
|
+
4. In Cursor, run `@spec-builder` before coding a feature, `@kiss-off` on a diff, `@look-over` before committing, and `@pr-runner` before pushing.
|
|
101
|
+
|
|
102
|
+
## How the pieces fit
|
|
103
|
+
|
|
104
|
+
A consumer repo installs the package, copies the pieces it wants, and tweaks them locally. The agents read the consumer `.documentation/AGENT-CONTEXT.md` first, so they cite real files and real paths instead of inventing them. The spec-builder outputs a spec in the same section order as `spec-template-generic.md`, and test-generator lists test cases against that spec, which task-breaker then turns into tasks.
|
|
30
105
|
|
|
31
106
|
## Develop (this repo)
|
|
32
107
|
|
|
@@ -39,6 +114,20 @@ npm run format:check
|
|
|
39
114
|
npm test
|
|
40
115
|
```
|
|
41
116
|
|
|
117
|
+
Tests are Playwright smoke tests in `tests/package-smoke.spec.ts`. They prove the rules, contexts, agents, and CLI entry exist, and that the package name is scoped for publish.
|
|
118
|
+
|
|
119
|
+
## Repo layout
|
|
120
|
+
|
|
121
|
+
```
|
|
122
|
+
bin/ revit-ai CLI entry (npx revit-ai)
|
|
123
|
+
cli/ install prompt and copy logic
|
|
124
|
+
rules/ .mdc Cursor rules
|
|
125
|
+
contexts/ context templates
|
|
126
|
+
agents/ agent definitions
|
|
127
|
+
tests/ Playwright smoke tests
|
|
128
|
+
.documentation/ this package's own docs
|
|
129
|
+
```
|
|
130
|
+
|
|
42
131
|
## Tooling
|
|
43
132
|
|
|
44
133
|
See [`.documentation/DECISIONS.md`](.documentation/DECISIONS.md) for irreversible package forks and why.
|
|
@@ -47,10 +136,10 @@ Commit message help: [`.documentation/CONVENTIONAL-COMMITS.md`](.documentation/C
|
|
|
47
136
|
|
|
48
137
|
## Release
|
|
49
138
|
|
|
50
|
-
Local first. When the export surface is stable:
|
|
51
|
-
|
|
52
139
|
```bash
|
|
53
140
|
npm run changeset
|
|
54
141
|
npx changeset version
|
|
55
|
-
|
|
142
|
+
npm publish
|
|
56
143
|
```
|
|
144
|
+
|
|
145
|
+
`npm run changeset` records the change and the bump type in a `.changeset/` file. `npx changeset version` applies the bump to `package.json`, writes the summary into `CHANGELOG.md`, and deletes the changeset file. Then `npm publish` ships it.
|