ai-ide-config 0.1.2 → 0.1.3
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 +3 -58
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,21 +4,10 @@ Scaffold shared Cursor IDE / agent setup into a project: shared `.cursor` rules/
|
|
|
4
4
|
|
|
5
5
|
## Install / run
|
|
6
6
|
|
|
7
|
-
No global install required:
|
|
8
|
-
|
|
9
7
|
```bash
|
|
10
8
|
npx ai-ide-config init
|
|
11
9
|
```
|
|
12
10
|
|
|
13
|
-
From a local checkout:
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
cd ai-ide-config
|
|
17
|
-
npm link
|
|
18
|
-
cd /path/to/your-project
|
|
19
|
-
npx ai-ide-config init
|
|
20
|
-
```
|
|
21
|
-
|
|
22
11
|
## Usage
|
|
23
12
|
|
|
24
13
|
```bash
|
|
@@ -43,17 +32,9 @@ Existing template files are **skipped** unless you pass `--force`.
|
|
|
43
32
|
- If missing → create it with `.cursor/` and `.agents/`
|
|
44
33
|
- If present → append `.cursor/` and/or `.agents/` only when missing
|
|
45
34
|
|
|
46
|
-
If `package.json` exists, init pins an **exact** `packageManager` / `devEngines.packageManager` to the installed pnpm version.
|
|
35
|
+
If `package.json` exists, init pins an **exact** `packageManager` / `devEngines.packageManager` to the installed pnpm version.
|
|
47
36
|
|
|
48
|
-
After scaffolding, the CLI runs
|
|
49
|
-
|
|
50
|
-
```bash
|
|
51
|
-
pnpx skills add midudev/autoskills
|
|
52
|
-
```
|
|
53
|
-
|
|
54
|
-
(`pnpx` is used instead of `npx` because the skills package requires pnpm via `devEngines`.)
|
|
55
|
-
|
|
56
|
-
Use `--skip-skills` to skip that step. On `--dry-run`, the command is only printed.
|
|
37
|
+
After scaffolding, the CLI runs `pnpx skills add midudev/autoskills` (use `--skip-skills` to skip; on `--dry-run` it is only printed).
|
|
57
38
|
|
|
58
39
|
In CI or non-TTY shells, pass `--stack` (or use `init-<stack>`). Interactive prompts require a terminal.
|
|
59
40
|
|
|
@@ -68,7 +49,7 @@ In CI or non-TTY shells, pass `--stack` (or use `init-<stack>`). Interactive pro
|
|
|
68
49
|
| `pnpm-workspace.yaml` | angular (`blockExoticSubdeps`, `minimumReleaseAge: 4320`) |
|
|
69
50
|
| `.gitignore` | create or append `.cursor/` and `.agents/` |
|
|
70
51
|
|
|
71
|
-
After init, edit `AGENTS.md` placeholders (`<PROJECT_NAME>`,
|
|
52
|
+
After init, edit `AGENTS.md` placeholders (`<PROJECT_NAME>`, `<VERSION>`, domains, paths) for the target repo.
|
|
72
53
|
|
|
73
54
|
## Stacks
|
|
74
55
|
|
|
@@ -76,42 +57,6 @@ After init, edit `AGENTS.md` placeholders (`<PROJECT_NAME>`, package manager, do
|
|
|
76
57
|
|----|-------|
|
|
77
58
|
| `angular` | Angular |
|
|
78
59
|
|
|
79
|
-
### Adding a stack
|
|
80
|
-
|
|
81
|
-
1. Add `templates/<stack>/AGENTS.md`
|
|
82
|
-
2. Register it in [`src/stacks.mjs`](src/stacks.mjs)
|
|
83
|
-
3. Document it here
|
|
84
|
-
|
|
85
|
-
Shared Cursor rules/commands stay under `templates/shared/`.
|
|
86
|
-
|
|
87
|
-
## Publishing to npm
|
|
88
|
-
|
|
89
|
-
CD publishes to npm when you create a **GitHub Release** (workflow: [`.github/workflows/publish.yml`](.github/workflows/publish.yml)).
|
|
90
|
-
|
|
91
|
-
### One-time setup
|
|
92
|
-
|
|
93
|
-
1. Create an [npmjs.com](https://www.npmjs.com) account and verify your email.
|
|
94
|
-
2. Create the package on npm (first publish can also create it), or claim the name `ai-ide-config`.
|
|
95
|
-
3. In the package settings on npm → **Trusted Publisher**:
|
|
96
|
-
- **Organization or user:** `iraldoad`
|
|
97
|
-
- **Repository:** `ai-ide-config`
|
|
98
|
-
- **Workflow filename:** `publish.yml`
|
|
99
|
-
- Allow **npm publish**
|
|
100
|
-
4. No `NPM_TOKEN` secret is required (OIDC Trusted Publishing).
|
|
101
|
-
|
|
102
|
-
### Release a version
|
|
103
|
-
|
|
104
|
-
1. Bump `version` in `package.json` (e.g. `0.1.1`).
|
|
105
|
-
2. Commit and push.
|
|
106
|
-
3. Create a GitHub Release for that commit (e.g. tag `v0.1.1`).
|
|
107
|
-
4. The workflow runs `npm publish --access public --provenance`.
|
|
108
|
-
|
|
109
|
-
After the first successful publish:
|
|
110
|
-
|
|
111
|
-
```bash
|
|
112
|
-
npx ai-ide-config init
|
|
113
|
-
```
|
|
114
|
-
|
|
115
60
|
## License
|
|
116
61
|
|
|
117
62
|
MIT
|