@chenpengfei/daily-brief 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/CHANGELOG.md +18 -0
- package/README.md +6 -0
- package/docs/user-manual.md +20 -4
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,24 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes for Formal Releases are recorded here. GitHub Release notes should be derived from the matching version entry.
|
|
4
4
|
|
|
5
|
+
## 0.1.1 - 2026-06-01
|
|
6
|
+
|
|
7
|
+
Patch release for first-install command discovery.
|
|
8
|
+
|
|
9
|
+
### User-visible Changes
|
|
10
|
+
|
|
11
|
+
- Updates installation documentation to use `$(npm prefix -g)/bin/daily-brief` for first setup, so users can run the installed CLI even when npm's global bin directory is not yet in their shell `PATH`.
|
|
12
|
+
- Clarifies that the shorter `daily-brief` command works after npm's global bin directory is added to `PATH`.
|
|
13
|
+
|
|
14
|
+
### Installation and Upgrade Notes
|
|
15
|
+
|
|
16
|
+
- Upgrade with `npm install -g @chenpengfei/daily-brief@latest`.
|
|
17
|
+
- If `daily-brief` is not found after installation, run `$(npm prefix -g)/bin/daily-brief setup`.
|
|
18
|
+
|
|
19
|
+
### Known Limitations
|
|
20
|
+
|
|
21
|
+
- npm may hide successful lifecycle script output during install, so this release uses visible documentation and release notes rather than a `postinstall` reminder.
|
|
22
|
+
|
|
5
23
|
## 0.1.0 - 2026-05-31
|
|
6
24
|
|
|
7
25
|
Initial Formal Release candidate for the Daily Brief Agent.
|
package/README.md
CHANGED
|
@@ -8,6 +8,12 @@ Daily Brief is distributed as the npm package `@chenpengfei/daily-brief` and ins
|
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
10
|
npm install -g @chenpengfei/daily-brief
|
|
11
|
+
"$(npm prefix -g)/bin/daily-brief" setup
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
After npm's global bin directory is in your shell `PATH`, you can use the shorter command:
|
|
15
|
+
|
|
16
|
+
```bash
|
|
11
17
|
daily-brief setup
|
|
12
18
|
```
|
|
13
19
|
|
package/docs/user-manual.md
CHANGED
|
@@ -8,7 +8,15 @@ Daily Brief is distributed as the npm package `@chenpengfei/daily-brief` and ins
|
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
10
|
npm install -g @chenpengfei/daily-brief
|
|
11
|
-
daily-brief --help
|
|
11
|
+
"$(npm prefix -g)/bin/daily-brief" --help
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
The explicit `$(npm prefix -g)/bin/daily-brief` path works even when npm's global bin directory is not in your shell `PATH`.
|
|
15
|
+
|
|
16
|
+
To use the shorter `daily-brief` command, add npm's global bin directory to your shell `PATH`:
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
export PATH="$(npm prefix -g)/bin:$PATH"
|
|
12
20
|
```
|
|
13
21
|
|
|
14
22
|
Daily Brief requires Node.js 22 or newer.
|
|
@@ -18,9 +26,11 @@ Daily Brief requires Node.js 22 or newer.
|
|
|
18
26
|
Run setup after installing the package:
|
|
19
27
|
|
|
20
28
|
```bash
|
|
21
|
-
daily-brief setup
|
|
29
|
+
"$(npm prefix -g)/bin/daily-brief" setup
|
|
22
30
|
```
|
|
23
31
|
|
|
32
|
+
If npm's global bin directory is in `PATH`, `daily-brief setup` is equivalent.
|
|
33
|
+
|
|
24
34
|
Setup creates user configuration and generated-data directories, initializes the Source Registry from the packaged example, prepares credential storage, and reports readiness. Setup does not collect Sources, call an LLM, generate a Daily Brief, or send a delivery notification.
|
|
25
35
|
|
|
26
36
|
By default, configuration files live under `~/.daily-brief/`, and generated data lives under `~/.daily-brief/data/`.
|
|
@@ -110,7 +120,7 @@ Upgrade the installed package through npm:
|
|
|
110
120
|
|
|
111
121
|
```bash
|
|
112
122
|
npm install -g @chenpengfei/daily-brief@latest
|
|
113
|
-
daily-brief status
|
|
123
|
+
"$(npm prefix -g)/bin/daily-brief" status
|
|
114
124
|
```
|
|
115
125
|
|
|
116
126
|
Run `daily-brief setup` again when release notes or status output indicate that configuration needs to be refreshed. Setup preserves existing files unless an overwrite or force behavior is explicitly selected.
|
|
@@ -120,7 +130,13 @@ Run `daily-brief setup` again when release notes or status output indicate that
|
|
|
120
130
|
If setup has not run, run:
|
|
121
131
|
|
|
122
132
|
```bash
|
|
123
|
-
daily-brief setup
|
|
133
|
+
"$(npm prefix -g)/bin/daily-brief" setup
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
If `daily-brief` is not found after a successful global install, run:
|
|
137
|
+
|
|
138
|
+
```bash
|
|
139
|
+
"$(npm prefix -g)/bin/daily-brief" setup
|
|
124
140
|
```
|
|
125
141
|
|
|
126
142
|
If Sources are not collected, run:
|