@ycniuqton/devlens 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.
Files changed (2) hide show
  1. package/README.md +19 -10
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -14,34 +14,43 @@ Devlens gives you a web-based UI to monitor file changes, manage tasks on a kanb
14
14
 
15
15
  ## Installation
16
16
 
17
+ Install globally:
18
+
17
19
  ```bash
18
- npm install -g devlens
20
+ npm install -g @ycniuqton/devlens
19
21
  ```
20
22
 
21
- Or install locally in your project:
23
+ Or use without installing via `npx` (note the `--package` flag because the package is scoped):
22
24
 
23
25
  ```bash
24
- npm install --save-dev devlens
26
+ npx --package=@ycniuqton/devlens -- devlens init
27
+ npx --package=@ycniuqton/devlens -- devlens start
25
28
  ```
26
29
 
27
30
  ## Quick Start
28
31
 
29
- ### 1. Start the dashboard
32
+ ### 1. Set up in your project
33
+
34
+ In any project directory, run:
30
35
 
31
36
  ```bash
32
- devlens start
37
+ devlens init
33
38
  ```
34
39
 
35
- This opens your browser at `http://localhost:4700` with the dashboard.
36
-
37
- ### 2. Set up Claude Code hooks (optional)
40
+ This installs Claude Code hooks (auto-start dashboard + task sync) and creates `.devlens/rules.md` with default rules. The dashboard port is derived from your project path so each project gets a unique stable port.
38
41
 
39
- If you use [Claude Code](https://claude.ai/claude-code), run this in your project directory to auto-sync tasks:
42
+ ### 2. Start the dashboard
40
43
 
41
44
  ```bash
42
- devlens init
45
+ devlens start
43
46
  ```
44
47
 
48
+ The dashboard opens at the project-specific port (shown after `devlens init`). It also auto-starts when you open a Claude Code session in that project.
49
+
50
+ ### 3. (Optional) Inside Claude Code
51
+
52
+ Type `/devlens` in any Claude Code session to see the current dashboard URL.
53
+
45
54
  This installs two hooks:
46
55
  - **Auto-start** — Launches the dashboard when a Claude Code session begins
47
56
  - **Task sync** — Sends task/todo updates to the dashboard in real-time
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ycniuqton/devlens",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },
@@ -35,7 +35,7 @@
35
35
  "diff2html": "^3.4.47",
36
36
  "express": "^4.18.2",
37
37
  "open": "^10.1.0",
38
- "simple-git": "^3.22.0",
38
+ "simple-git": "~3.33.0",
39
39
  "ws": "^8.16.0"
40
40
  },
41
41
  "devDependencies": {