Skip to content

Commit 4f56b34

Browse files
author
Test User
committed
docs: update all npm package references to scoped @doplan-dev/doplan-cli
- Update NPM_PUBLISHING.md with scoped package name - Update NPM_SETUP.md installation instructions - Update press release templates - Ensure consistency across all documentation
1 parent d08a8eb commit 4f56b34

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

NPM_SETUP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Users can now install via npm:
9898

9999
```bash
100100
# Global installation
101-
npm install -g doplan-cli
101+
npm install -g @doplan-dev/doplan-cli
102102

103103
# Verify
104104
doplan --version

docs/development/NPM_PUBLISHING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This document describes how to publish the DoPlan CLI to npm.
44

55
## Overview
66

7-
The DoPlan CLI is published to npm as `doplan-cli`. The npm package includes a wrapper script that automatically downloads the platform-specific binary from GitHub releases.
7+
The DoPlan CLI is published to npm as `@doplan-dev/doplan-cli`. The npm package includes a wrapper script that automatically downloads the platform-specific binary from GitHub releases.
88

99
## Package Structure
1010

@@ -26,7 +26,7 @@ Publishing to npm is automated via GitHub Actions. When you push a tag matching
2626

2727
**Requirements:**
2828
- `NPM_TOKEN` secret must be configured in GitHub repository settings
29-
- Token must have publish permissions for the `doplan-cli` package
29+
- Token must have publish permissions for the `@doplan-dev/doplan-cli` package
3030

3131
### Manual Publishing
3232

@@ -46,7 +46,7 @@ npm run prepublishOnly
4646
npm publish
4747

4848
# 5. Verify publication
49-
npm view doplan-cli
49+
npm view @doplan-dev/doplan-cli
5050
```
5151

5252
## Setting up NPM_TOKEN
@@ -67,14 +67,14 @@ npm view doplan-cli
6767

6868
## Package Details
6969

70-
- **Package Name:** `doplan-cli`
70+
- **Package Name:** `@doplan-dev/doplan-cli`
7171
- **Registry:** https://registry.npmjs.org/
7272
- **Access:** Public
7373
- **Scoped:** No (public package)
7474

7575
## How It Works
7676

77-
1. **Installation:** When users run `npm install -g doplan-cli`:
77+
1. **Installation:** When users run `npm install -g @doplan-dev/doplan-cli`:
7878
- npm installs the package files
7979
- `postinstall.js` runs automatically
8080
- Downloads the platform-specific binary from GitHub releases
@@ -160,5 +160,5 @@ Excluded files:
160160
For issues with npm publishing:
161161
- Check GitHub Actions workflow logs
162162
- Verify npm token permissions
163-
- Review npm package page: https://www.npmjs.com/package/doplan-cli
163+
- Review npm package page: https://www.npmjs.com/package/@doplan-dev/doplan-cli
164164

press/one-pager.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ DoPlan is a project workflow automation tool that transforms app ideas into stru
3737
brew install doplan
3838

3939
# npm (Node.js)
40-
npm install -g doplan-cli
40+
npm install -g @doplan-dev/doplan-cli
4141

4242
# Direct download
4343
# Visit https://github.com/DoPlan-dev/CLI/releases

press/press-release-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ DoPlan automates the tedious aspects of project management by generating documen
2121

2222
DoPlan CLI is available now via:
2323
- **Homebrew**: `brew install doplan`
24-
- **npm**: `npm install -g doplan-cli`
24+
- **npm**: `npm install -g @doplan-dev/doplan-cli`
2525
- **Direct download**: https://github.com/DoPlan-dev/CLI/releases
2626

2727
### Use Cases

0 commit comments

Comments
 (0)