Skip to content

Commit 29b89d2

Browse files
Prepare scoped npm package
1 parent 44049d8 commit 29b89d2

5 files changed

Lines changed: 22 additions & 16 deletions

File tree

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,17 @@ Intelligent project setup & management CLI. Auto-detects your stack, installs de
55
## Installation
66

77
```bash
8-
npx setupr
8+
npx @evan-coder/setupr
99
```
1010

1111
Or install globally:
1212

1313
```bash
14-
npm install -g setupr
14+
npm install -g @evan-coder/setupr
1515
```
1616

17+
The npm package is published under the owned scope `@evan-coder/setupr`, but the installed terminal command is still `setupr`.
18+
1719
## Quick Start
1820

1921
```bash
@@ -507,12 +509,13 @@ That does not replace manual iTerm2/Ghostty visual QA, but it catches obvious TU
507509
For a local package/install smoke before publishing:
508510

509511
```bash
510-
npm pack
511-
npm exec --yes --package ./setupr-1.0.0.tgz -- setupr --version
512-
npx --yes file:$(pwd)/setupr-1.0.0.tgz --version
512+
pkg=$(npm pack --silent)
513+
npm exec --yes --package "./$pkg" -- setupr --version
514+
npx --yes "file:$(pwd)/$pkg" --version
515+
npm publish --dry-run
513516
```
514517

515-
Use `file:` or `--package` for tarball checks. A bare `npx ./setupr-1.0.0.tgz` is treated like an executable file path and will fail with a permission error.
518+
Use `file:` or `--package` for tarball checks. A bare `npx ./$pkg` is treated like an executable file path and will fail with a permission error. Scoped packages must be public when published, so `package.json` includes `publishConfig.access = "public"`.
516519

517520
## License
518521

SETUP.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,18 @@
1111
### Via npx (recommended)
1212

1313
```bash
14-
npx setupr
14+
npx @evan-coder/setupr
1515
```
1616

1717
This runs Setupr without installing it globally.
1818

1919
### Global Installation
2020

2121
```bash
22-
npm install -g setupr
22+
npm install -g @evan-coder/setupr
2323
```
2424

25-
After installation, the `setup` command is available globally:
25+
After installation, the `setupr` and legacy `setup` commands are available globally:
2626

2727
```bash
2828
setup
@@ -57,7 +57,7 @@ node dist/setup.js --help
5757
## First Run
5858

5959
1. Navigate to any project directory
60-
2. Run `setup` (or `npx setupr`)
60+
2. Run `setupr` (or `npx @evan-coder/setupr`)
6161
3. Setupr will:
6262
- Display a pre-execution warning
6363
- Ask you to confirm (press Enter)

TROUBLESHOOTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -101,7 +101,7 @@ Raw API keys and token-like values are masked in error output and AI context.
101101

102102
**Fix**: Use npx instead:
103103
```bash
104-
npx setupr
104+
npx @evan-coder/setupr
105105
```
106106

107107
Or fix npm permissions: https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "setupr",
2+
"name": "@evan-coder/setupr",
33
"version": "1.0.0",
44
"description": "Intelligent project setup & management CLI. Auto-detects your stack, installs dependencies, configures environments, and keeps projects healthy.",
55
"type": "module",
@@ -12,8 +12,11 @@
1212
},
1313
"homepage": "https://github.com/Evan1108-Coder/Setupr#readme",
1414
"bin": {
15-
"setupr": "./dist/setup.js",
16-
"setup": "./dist/setup.js"
15+
"setupr": "dist/setup.js",
16+
"setup": "dist/setup.js"
17+
},
18+
"publishConfig": {
19+
"access": "public"
1720
},
1821
"files": [
1922
"dist/",

0 commit comments

Comments
 (0)